{ "openapi": "3.0.2", "info": { "version": "28", "title": "Kiteworks API — folders Operations" }, "paths": { "/rest/folders": { "delete": { "tags": [ "folders" ], "summary": "Delete a list of folders", "description": "Deletes multiple folders specified in the request.", "responses": { "204": { "description": "The specified folders were deleted. No content is returned." }, "490": { "description": "Request blocked by WAF" } }, "deprecated": false, "parameters": [ { "in": "query", "name": "id:in", "description": "A comma-separated list of unique identifiers for the entities to be processed.. A comma-separated list of unique identifiers for the entities to be processed.", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "partialSuccess", "description": "If set to `true`, the operation will continue for the valid items even if some items result in failure.", "schema": { "type": "boolean" } }, { "in": "query", "name": "mode", "description": "Determines the detail level of the response body.", "schema": { "type": "string", "enum": [ "full_with_links", "full" ] } } ], "x-codeSamples": [ { "lang": "Shell", "label": "cURL", "source": "curl -X DELETE \\\n \"https://{instance}.kiteworks.com/rest/folders?id:in=VALUE\" \\\n -H \"Authorization: Bearer YOUR_TOKEN\"" }, { "lang": "Python", "label": "Python", "source": "import requests\n\nurl = \"https://{instance}.kiteworks.com/rest/folders\"\nheaders = {\n \"Authorization\": \"Bearer YOUR_TOKEN\",\n}\nparams = {\n \"id:in\": \"VALUE\",\n}\nresponse = requests.delete(url, params=params, headers=headers)\nprint(response.json())" } ] } }, "/rest/folders/actions/permanent": { "delete": { "tags": [ "folders" ], "summary": "Permanently delete the specified folders", "description": "Permanently delete the specified folders.\n These folders will no longer be accessible by any means.", "responses": { "204": { "description": "The specified folders were permanently deleted. No content is returned." }, "490": { "description": "Request blocked by WAF" } }, "deprecated": false, "parameters": [ { "in": "query", "name": "id:in", "description": "A comma-separated list of unique identifiers for the entities to be processed.. A comma-separated list of unique identifiers for the entities to be processed.", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "partialSuccess", "description": "If set to `true`, the operation will continue for the valid items even if some items result in failure.", "schema": { "type": "boolean" } }, { "in": "query", "name": "mode", "description": "Determines the detail level of the response body.", "schema": { "type": "string", "enum": [ "full_with_links", "full" ] } } ], "x-codeSamples": [ { "lang": "Shell", "label": "cURL", "source": "curl -X DELETE \\\n \"https://{instance}.kiteworks.com/rest/folders/actions/permanent?id:in=VALUE\" \\\n -H \"Authorization: Bearer YOUR_TOKEN\"" }, { "lang": "Python", "label": "Python", "source": "import requests\n\nurl = \"https://{instance}.kiteworks.com/rest/folders/actions/permanent\"\nheaders = {\n \"Authorization\": \"Bearer YOUR_TOKEN\",\n}\nparams = {\n \"id:in\": \"VALUE\",\n}\nresponse = requests.delete(url, params=params, headers=headers)\nprint(response.json())" } ] } }, "/rest/folders/actions/recover": { "patch": { "tags": [ "folders" ], "summary": "Recover deleted folders", "description": "Recover deleted folders and their children files and folders.", "responses": { "200": { "description": "Returns the list of recovered folders with their updated metadata.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Folder" } }, "metadata": { "$ref": "#/components/schemas/MetaData" } } }, "examples": { "RecoveredFolders": { "summary": "Folders successfully recovered", "value": [ { "id": "abc12345def67890ab", "name": "Reports", "type": "d", "parent_id": "xyz98765cba43210fe", "deleted": false, "modified": "2024-07-01T10:00:00+0000", "avStatus": "clean", "dlpStatus": "clean" } ] } } } } }, "490": { "description": "Request blocked by WAF" } }, "deprecated": false, "parameters": [ { "in": "query", "name": "id:in", "description": "A comma-separated list of unique identifiers for the entities to be processed.. A comma-separated list of unique identifiers for the entities to be processed.", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "partialSuccess", "description": "If set to `true`, the operation will continue for the valid items even if some items result in failure.", "schema": { "type": "boolean" } }, { "in": "query", "name": "returnEntity", "description": "If set to `true`, returns information about the newly created entity.", "schema": { "type": "boolean" } }, { "in": "query", "name": "mode", "description": "Determines the detail level of the response body.", "schema": { "type": "string", "enum": [ "full_with_links", "full" ] } } ], "x-codeSamples": [ { "lang": "Shell", "label": "cURL", "source": "curl -X PATCH \\\n \"https://{instance}.kiteworks.com/rest/folders/actions/recover?id:in=VALUE\" \\\n -H \"Authorization: Bearer YOUR_TOKEN\"" }, { "lang": "Python", "label": "Python", "source": "import requests\n\nurl = \"https://{instance}.kiteworks.com/rest/folders/actions/recover\"\nheaders = {\n \"Authorization\": \"Bearer YOUR_TOKEN\",\n}\nparams = {\n \"id:in\": \"VALUE\",\n}\nresponse = requests.patch(url, params=params, headers=headers)\nprint(response.json())" } ] } }, "/rest/folders/actions/scan": { "post": { "tags": [ "folders" ], "summary": "Triggers on demand AV/DLP scan on multiple folders", "description": "Attempts to trigger an AV/DLP scan on requested folders.", "responses": { "200": { "description": "Returns the list of folders with their scan status updated to reflect that scans have been triggered.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Folder" } }, "metadata": { "$ref": "#/components/schemas/MetaData" } } }, "examples": { "BulkScanTriggered": { "summary": "Scans triggered — statuses are pending", "value": [ { "id": "abc12345def67890ab", "name": "Reports", "type": "d", "parent_id": "xyz98765cba43210fe", "deleted": false, "avStatus": "pending", "dlpStatus": "pending" }, { "id": "def67890abc12345fe", "name": "Archives", "type": "d", "parent_id": "xyz98765cba43210fe", "deleted": false, "avStatus": "pending", "dlpStatus": "pending" } ] } } } } }, "490": { "description": "Request blocked by WAF" } }, "deprecated": false, "parameters": [ { "in": "query", "name": "returnEntity", "description": "If set to `true`, returns information about the newly created entity.", "schema": { "type": "boolean" } }, { "in": "query", "name": "id:in", "description": "List of IDs of entities to scan. Search for results that match any of the specified values for this parameter.", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "with", "description": "With parameters", "schema": { "type": "string" } }, { "in": "query", "name": "mode", "description": "Determines the detail level of the response body.", "schema": { "type": "string", "enum": [ "full_with_links", "full", "compact" ] } } ], "x-codeSamples": [ { "lang": "Shell", "label": "cURL", "source": "curl -X POST \\\n \"https://{instance}.kiteworks.com/rest/folders/actions/scan?id:in=VALUE\" \\\n -H \"Authorization: Bearer YOUR_TOKEN\"" }, { "lang": "Python", "label": "Python", "source": "import requests\n\nurl = \"https://{instance}.kiteworks.com/rest/folders/actions/scan\"\nheaders = {\n \"Authorization\": \"Bearer YOUR_TOKEN\",\n}\nparams = {\n \"id:in\": \"VALUE\",\n}\nresponse = requests.post(url, params=params, headers=headers)\nprint(response.json())" } ] } }, "/rest/folders/shared": { "get": { "tags": [ "folders" ], "summary": "List top level shared folders", "description": "Return the list of top level shared folders.", "responses": { "200": { "description": "Returns a paginated list of top-level folders shared with the current user.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Folder" } }, "metadata": { "$ref": "#/components/schemas/MetaData" } } }, "examples": { "SharedFolderList": { "summary": "A page of shared folders", "value": [ { "id": "abc12345def67890ab", "name": "Team Workspace", "description": "Shared team files", "type": "d", "parent_id": "xyz98765cba43210fe", "deleted": false, "created": "2024-01-10T09:00:00+0000", "modified": "2024-06-20T11:30:00+0000", "syncable": false, "secure": false, "isFavorite": true, "isShared": true, "totalFilesCount": 25, "totalFoldersCount": 5, "totalMembersCount": 8, "avStatus": "clean", "dlpStatus": "clean" } ] } } } } }, "490": { "description": "Request blocked by WAF" } }, "deprecated": false, "parameters": [ { "in": "query", "name": "name", "description": "Folder name", "schema": { "type": "string" } }, { "in": "query", "name": "name:contains", "description": "Folder name. Search for results that contain the specified characters in this parameter.", "schema": { "type": "string" } }, { "in": "query", "name": "userId", "description": "Unique identifier of Object creator", "schema": { "type": "string" } }, { "in": "query", "name": "userId:in", "description": "Unique identifier of Object creator. Search for results that match any of the specified values for this parameter.", "schema": { "type": "string" } }, { "in": "query", "name": "created", "description": "Object creation date", "schema": { "type": "string", "format": "date" } }, { "in": "query", "name": "created:gt", "description": "Object creation date. Search for results where this parameter value is greater than the specified value.", "schema": { "type": "string", "format": "date" } }, { "in": "query", "name": "created:gte", "description": "Object creation date. Search for results where this parameter value is greater than or equal to the specified value.", "schema": { "type": "string", "format": "date" } }, { "in": "query", "name": "created:lt", "description": "Object creation date. Search for results where this parameter value is less than the specified value.", "schema": { "type": "string", "format": "date" } }, { "in": "query", "name": "created:lte", "description": "Object creation date. Search for results where this parameter value is less than or equal to the specified value.", "schema": { "type": "string", "format": "date" } }, { "in": "query", "name": "modified", "description": "Object modification date", "schema": { "type": "string", "format": "date" } }, { "in": "query", "name": "modified:gt", "description": "Object modification date. Search for results where this parameter value is greater than the specified value.", "schema": { "type": "string", "format": "date" } }, { "in": "query", "name": "modified:gte", "description": "Object modification date. Search for results where this parameter value is greater than or equal to the specified value.", "schema": { "type": "string", "format": "date" } }, { "in": "query", "name": "modified:lt", "description": "Object modification date. Search for results where this parameter value is less than the specified value.", "schema": { "type": "string", "format": "date" } }, { "in": "query", "name": "modified:lte", "description": "Object modification date. Search for results where this parameter value is less than or equal to the specified value.", "schema": { "type": "string", "format": "date" } }, { "in": "query", "name": "deleted", "description": "Indicates whether the object is deleted.", "schema": { "type": "boolean" } }, { "in": "query", "name": "expire", "description": "Expiration date", "schema": { "type": "integer" } }, { "in": "query", "name": "expire:gt", "description": "Expiration date. Search for results where this parameter value is greater than the specified value.", "schema": { "type": "integer" } }, { "in": "query", "name": "expire:gte", "description": "Expiration date. Search for results where this parameter value is greater than or equal to the specified value.", "schema": { "type": "integer" } }, { "in": "query", "name": "expire:lt", "description": "Expiration date. Search for results where this parameter value is less than the specified value.", "schema": { "type": "integer" } }, { "in": "query", "name": "expire:lte", "description": "Expiration date. Search for results where this parameter value is less than or equal to the specified value.", "schema": { "type": "integer" } }, { "in": "query", "name": "fileLifetime", "description": "Folder lifetime", "schema": { "type": "integer" } }, { "in": "query", "name": "fileLifetime:gt", "description": "Folder lifetime. Search for results where this parameter value is greater than the specified value.", "schema": { "type": "integer" } }, { "in": "query", "name": "fileLifetime:gte", "description": "Folder lifetime. Search for results where this parameter value is greater than or equal to the specified value.", "schema": { "type": "integer" } }, { "in": "query", "name": "fileLifetime:lt", "description": "Folder lifetime. Search for results where this parameter value is less than the specified value.", "schema": { "type": "integer" } }, { "in": "query", "name": "fileLifetime:lte", "description": "Folder lifetime. Search for results where this parameter value is less than or equal to the specified value.", "schema": { "type": "integer" } }, { "in": "query", "name": "secure", "description": "Folder secure flag", "schema": { "type": "boolean" } }, { "in": "query", "name": "description:contains", "description": "Folder description. Search for results that contain the specified characters in this parameter.", "schema": { "type": "string" } }, { "in": "query", "name": "sharedByMe", "description": "Filter shared folders by direction. Use `true` to return only folders shared by me, `false` for folders shared with me, or omit to return both.", "schema": { "type": "boolean" } }, { "in": "query", "name": "orderBy", "description": "Sorting options", "schema": { "type": "array", "items": { "type": "string" }, "enum": [ "name:asc", "name:desc", "created:asc", "created:desc", "modified:asc", "modified:desc" ] } }, { "in": "query", "name": "offset", "description": "Offset", "schema": { "type": "integer" } }, { "in": "query", "name": "limit", "description": "Limit", "schema": { "type": "integer" } }, { "in": "query", "name": "with", "description": "With parameters", "schema": { "type": "string" } }, { "in": "query", "name": "mode", "description": "Determines the detail level of the response body.", "schema": { "type": "string", "enum": [ "full_with_links", "full", "compact" ] } } ], "x-codeSamples": [ { "lang": "Shell", "label": "cURL", "source": "curl -X GET \\\n \"https://{instance}.kiteworks.com/rest/folders/shared\" \\\n -H \"Authorization: Bearer YOUR_TOKEN\"" }, { "lang": "Python", "label": "Python", "source": "import requests\n\nurl = \"https://{instance}.kiteworks.com/rest/folders/shared\"\nheaders = {\n \"Authorization\": \"Bearer YOUR_TOKEN\",\n}\nresponse = requests.get(url, headers=headers)\nprint(response.json())" } ] } }, "/rest/folders/{id}/actions/move": { "post": { "summary": "Move a folder", "description": "### Description:\n Moves the specified folder to a new destination folder.\n### Precondition:\n User must have `folder_move` permission for the folder being moved.\n User must have `folder_add` permission for the destination folder.\n### Response:\n The folder is moved to the destination folder.\n", "tags": [ "folders" ], "parameters": [ { "in": "path", "name": "id", "required": true, "description": "The unique identifier (UUID) of the entity.", "schema": { "type": "string", "format": "uuid" } }, { "in": "query", "name": "returnEntity", "required": false, "description": "If true, includes the entity in the response body.", "schema": { "type": "boolean" } }, { "in": "query", "name": "with", "required": false, "description": "Specifies additional fields to include in the response.", "schema": { "type": "string" } }, { "in": "query", "name": "mode", "required": false, "description": "Determines the detail level of the response body.", "schema": { "type": "string", "enum": [ "compact", "full_no_links", "full_with_links", "full" ] } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DestinationFolderIdRequest" } } } }, "responses": { "201": { "description": "Folder successfully moved", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Folder1" } } } }, "401": { "description": "Unauthorized

Possible error codes: ERR_AUTH_INVALID_CSRF, ERR_AUTH_UNAUTHORIZED", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Errors" }, "examples": { "ERR_AUTH_INVALID_CSRF": { "summary": "Invalid CSRF Authentication", "description": "Invalid CSRF Authentication", "value": { "errors": [ { "code": "ERR_AUTH_INVALID_CSRF", "message": "Invalid CSRF Authentication" } ] } }, "ERR_AUTH_UNAUTHORIZED": { "summary": "Unauthorized", "description": "Unauthorized", "value": { "errors": [ { "code": "ERR_AUTH_UNAUTHORIZED", "message": "Unauthorized" } ] } } } } } }, "403": { "description": "Forbidden

Possible error codes: ERR_ACCESS_USER, ERR_ENTITY_CONTAINS_LOCKED_FILES, ERR_ENTITY_IS_BASE_DIR, ERR_ENTITY_IS_MY_DIR, ERR_ENTITY_IS_SECURE_FOLDER, ERR_ENTITY_IS_SYNC_DIR", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Errors" }, "examples": { "ERR_ACCESS_USER": { "summary": "Insufficient access permissions", "description": "Insufficient access permissions", "value": { "errors": [ { "code": "ERR_ACCESS_USER", "message": "Insufficient access permissions" } ] } }, "ERR_ENTITY_CONTAINS_LOCKED_FILES": { "summary": "Folder contains locked files", "description": "Folder contains locked files", "value": { "errors": [ { "code": "ERR_ENTITY_CONTAINS_LOCKED_FILES", "message": "Folder contains locked files" } ] } }, "ERR_ENTITY_IS_BASE_DIR": { "summary": "Operation not permitted on Base Folder", "description": "Operation not permitted on Base Folder", "value": { "errors": [ { "code": "ERR_ENTITY_IS_BASE_DIR", "message": "Operation not permitted on Base Folder" } ] } }, "ERR_ENTITY_IS_MY_DIR": { "summary": "Operation not permitted on Tray Folder", "description": "Operation not permitted on Tray Folder", "value": { "errors": [ { "code": "ERR_ENTITY_IS_MY_DIR", "message": "Operation not permitted on Tray Folder" } ] } }, "ERR_ENTITY_IS_SECURE_FOLDER": { "summary": "Operation not permitted on restricted Folder.", "description": "Operation not permitted on restricted Folder.", "value": { "errors": [ { "code": "ERR_ENTITY_IS_SECURE_FOLDER", "message": "Operation not permitted on restricted Folder." } ] } }, "ERR_ENTITY_IS_SYNC_DIR": { "summary": "Operation not permitted on My Folder", "description": "Operation not permitted on My Folder", "value": { "errors": [ { "code": "ERR_ENTITY_IS_SYNC_DIR", "message": "Operation not permitted on My Folder" } ] } } } } } }, "409": { "description": "Conflict

Possible error codes: ERR_ENTITY_EXISTS", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Errors" }, "examples": { "ERR_ENTITY_EXISTS": { "summary": "Entity exists", "description": "Entity exists", "value": { "errors": [ { "code": "ERR_ENTITY_EXISTS", "message": "Entity exists" } ] } } } } } }, "413": { "description": "Content Too Large

Possible error codes: ERR_SYSTEM_NO_STORAGE_AVAILABLE", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Errors" }, "examples": { "ERR_SYSTEM_NO_STORAGE_AVAILABLE": { "summary": "Folder owner's remaining storage quota does not permit for a file upload of this size.", "description": "Folder owner's remaining storage quota does not permit for a file upload of this size.", "value": { "errors": [ { "code": "ERR_SYSTEM_NO_STORAGE_AVAILABLE", "message": "Folder owner's remaining storage quota does not permit for a file upload of this size." } ] } } } } } }, "422": { "description": "Unprocessable Content

Possible error codes: ERR_CANNOT_MOVE_FOLDER_TO_SELF, ERR_CANNOT_MOVE_TO_CHILD, ERR_INVALID_PARAMETER", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Errors" }, "examples": { "ERR_CANNOT_MOVE_FOLDER_TO_SELF": { "summary": "Cannot move folder to itself", "description": "Cannot move folder to itself", "value": { "errors": [ { "code": "ERR_CANNOT_MOVE_FOLDER_TO_SELF", "message": "Cannot move folder to itself" } ] } }, "ERR_CANNOT_MOVE_TO_CHILD": { "summary": "Cannot move folder to its child", "description": "Cannot move folder to its child", "value": { "errors": [ { "code": "ERR_CANNOT_MOVE_TO_CHILD", "message": "Cannot move folder to its child" } ] } }, "ERR_INVALID_PARAMETER": { "summary": "Invalid Parameter Exception", "description": "Invalid Parameter Exception", "value": { "errors": [ { "code": "ERR_INVALID_PARAMETER", "message": "Invalid Parameter Exception" } ] } } } } } }, "490": { "description": "Request blocked by WAF" } }, "x-codeSamples": [ { "lang": "Shell", "label": "cURL", "source": "curl -X POST \\\n \"https://{instance}.kiteworks.com/rest/folders/:id/actions/move\" \\\n -H \"Authorization: Bearer YOUR_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"destinationFolderId\": \"string\",\n \"addVersion\": true\n }'" }, { "lang": "Python", "label": "Python", "source": "import requests\n\nid = \"VALUE\" # The unique identifier (UUID) of the entity.\n\nurl = f\"https://{{instance}}.kiteworks.com/rest/folders/{id}/actions/move\"\nheaders = {\n \"Authorization\": \"Bearer YOUR_TOKEN\",\n \"Content-Type\": \"application/json\",\n}\npayload = {\n \"destinationFolderId\": \"string\",\n \"addVersion\": true\n}\nresponse = requests.post(url, headers=headers, json=payload)\nprint(response.json())" } ] } }, "/rest/folders/{id}/actions/permanent": { "delete": { "tags": [ "folders" ], "summary": "Permanently delete the specified folder", "description": "Permanently delete the specified folder.\n This folder will no longer be accessible by any means.", "responses": { "204": { "description": "The folder was permanently deleted. No content is returned." }, "490": { "description": "Request blocked by WAF" } }, "deprecated": false, "parameters": [ { "in": "path", "name": "id", "description": "The unique identifier (UUID) of the folder.", "required": true, "schema": { "type": "string" } } ], "x-codeSamples": [ { "lang": "Shell", "label": "cURL", "source": "curl -X DELETE \\\n \"https://{instance}.kiteworks.com/rest/folders/:id/actions/permanent\" \\\n -H \"Authorization: Bearer YOUR_TOKEN\"" }, { "lang": "Python", "label": "Python", "source": "import requests\n\nid = \"VALUE\" # The unique identifier (UUID) of the folder.\n\nurl = f\"https://{{instance}}.kiteworks.com/rest/folders/{id}/actions/permanent\"\nheaders = {\n \"Authorization\": \"Bearer YOUR_TOKEN\",\n}\nresponse = requests.delete(url, headers=headers)\nprint(response.json())" } ] } }, "/rest/folders/{id}/actions/recover": { "patch": { "tags": [ "folders" ], "summary": "Recover deleted folder", "description": "Recover the specified folder. This un-marks the folder for deletion.", "responses": { "200": { "description": "Returns the recovered folder with its updated metadata.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Folder" }, "examples": { "RecoveredFolder": { "summary": "Folder successfully recovered", "value": { "id": "abc12345def67890ab", "name": "Reports", "description": "Quarterly reports", "type": "d", "parent_id": "xyz98765cba43210fe", "deleted": false, "created": "2024-03-01T08:00:00+0000", "modified": "2024-07-01T10:00:00+0000", "syncable": false, "secure": false, "isFavorite": false, "isShared": false, "totalFilesCount": 5, "totalFoldersCount": 1, "totalMembersCount": 0, "avStatus": "clean", "dlpStatus": "clean" } } } } } }, "490": { "description": "Request blocked by WAF" } }, "deprecated": false, "parameters": [ { "in": "path", "name": "id", "description": "The unique identifier (UUID) of the folder.", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "returnEntity", "description": "If set to `true`, returns information about the newly created entity.", "schema": { "type": "boolean" } }, { "in": "query", "name": "mode", "description": "Determines the detail level of the response body.", "schema": { "type": "string", "enum": [ "full_with_links", "full" ] } } ], "x-codeSamples": [ { "lang": "Shell", "label": "cURL", "source": "curl -X PATCH \\\n \"https://{instance}.kiteworks.com/rest/folders/:id/actions/recover\" \\\n -H \"Authorization: Bearer YOUR_TOKEN\"" }, { "lang": "Python", "label": "Python", "source": "import requests\n\nid = \"VALUE\" # The unique identifier (UUID) of the folder.\n\nurl = f\"https://{{instance}}.kiteworks.com/rest/folders/{id}/actions/recover\"\nheaders = {\n \"Authorization\": \"Bearer YOUR_TOKEN\",\n}\nresponse = requests.patch(url, headers=headers)\nprint(response.json())" } ] } }, "/rest/folders/{id}/actions/scan": { "post": { "tags": [ "folders" ], "summary": "Triggers on demand AV/DLP folder scan", "description": "Attempts to trigger an AV/DLP scan on requested folder.", "responses": { "200": { "description": "Returns the folder with its scan status updated to reflect that a scan has been triggered.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Folder" }, "examples": { "ScanTriggered": { "summary": "Scan triggered — status is pending", "value": { "id": "abc12345def67890ab", "name": "Reports", "type": "d", "parent_id": "xyz98765cba43210fe", "deleted": false, "avStatus": "pending", "dlpStatus": "pending" } } } } } }, "403": { "description": "Forbidden

Possible error codes: ERR_ACCESS_USER", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Errors" }, "examples": { "ERR_ACCESS_USER": { "summary": "Insufficient access permissions", "description": "Insufficient access permissions", "value": { "errors": { "code": "ERR_ACCESS_USER", "message": "Insufficient access permissions" } } } } } } }, "490": { "description": "Request blocked by WAF" } }, "deprecated": false, "parameters": [ { "in": "path", "name": "id", "description": "The unique identifier (UUID) of the folder.", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "returnEntity", "description": "If set to `true`, returns information about the newly created entity.", "schema": { "type": "boolean" } }, { "in": "query", "name": "folderId:in", "description": "List of folder IDs of entities to scan. Search for results that match any of the specified values for this parameter.", "schema": { "type": "string" } }, { "in": "query", "name": "fileId:in", "description": "List of file IDs of entities to scan. Search for results that match any of the specified values for this parameter.", "schema": { "type": "string" } }, { "in": "query", "name": "with", "description": "With parameters", "schema": { "type": "string" } }, { "in": "query", "name": "mode", "description": "Determines the detail level of the response body.", "schema": { "type": "string", "enum": [ "full_with_links", "full", "compact" ] } } ], "x-codeSamples": [ { "lang": "Shell", "label": "cURL", "source": "curl -X POST \\\n \"https://{instance}.kiteworks.com/rest/folders/:id/actions/scan\" \\\n -H \"Authorization: Bearer YOUR_TOKEN\"" }, { "lang": "Python", "label": "Python", "source": "import requests\n\nid = \"VALUE\" # The unique identifier (UUID) of the folder.\n\nurl = f\"https://{{instance}}.kiteworks.com/rest/folders/{id}/actions/scan\"\nheaders = {\n \"Authorization\": \"Bearer YOUR_TOKEN\",\n}\nresponse = requests.post(url, headers=headers)\nprint(response.json())" } ] } }, "/rest/folders/{id}/actions/sendMessage": { "post": { "summary": "Send message from a folder", "description": "### Description:\nSends a message from the specified folder to members of the folder.\n\n### Precondition:\nThe user must be a member of the folder.\n\n### Response:\nThe message has been successfully sent to members.\n", "tags": [ "folders" ], "parameters": [ { "in": "path", "name": "id", "required": true, "description": "The unique identifier (UUID) of the entity.", "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FolderSendMessageRequest" } } } }, "responses": { "201": { "description": "The message has been successfully sent to members.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Mail" } } } }, "401": { "description": "Unauthorized

Possible error codes: ERR_AUTH_INVALID_CSRF, ERR_AUTH_UNAUTHORIZED", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Errors" }, "examples": { "ERR_AUTH_INVALID_CSRF": { "summary": "Invalid CSRF Authentication", "description": "Invalid CSRF Authentication", "value": { "errors": [ { "code": "ERR_AUTH_INVALID_CSRF", "message": "Invalid CSRF Authentication" } ] } }, "ERR_AUTH_UNAUTHORIZED": { "summary": "Unauthorized", "description": "Unauthorized", "value": { "errors": [ { "code": "ERR_AUTH_UNAUTHORIZED", "message": "Unauthorized" } ] } } } } } }, "403": { "description": "Forbidden

Possible error codes: ERR_ACCESS_USER, ERR_ENTITY_DELETED", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Errors" }, "examples": { "ERR_ACCESS_USER": { "summary": "Insufficient access permissions", "description": "Insufficient access permissions", "value": { "errors": [ { "code": "ERR_ACCESS_USER", "message": "Insufficient access permissions" } ] } }, "ERR_ENTITY_DELETED": { "summary": "Entity is deleted", "description": "Entity is deleted", "value": { "errors": [ { "code": "ERR_ENTITY_DELETED", "message": "Entity is deleted" } ] } } } } } }, "422": { "description": "Unprocessable Content

Possible error codes: ERR_INVALID_PARAMETER", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Errors" }, "examples": { "ERR_INVALID_PARAMETER": { "summary": "Invalid Parameter Exception", "description": "Invalid Parameter Exception", "value": { "errors": [ { "code": "ERR_INVALID_PARAMETER", "message": "Invalid Parameter Exception" } ] } } } } } }, "490": { "description": "Request blocked by WAF" } }, "x-codeSamples": [ { "lang": "Shell", "label": "cURL", "source": "curl -X POST \\\n \"https://{instance}.kiteworks.com/rest/folders/:id/actions/sendMessage\" \\\n -H \"Authorization: Bearer YOUR_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"to\": [\n \"string\"\n ],\n \"cc\": [\n \"string\"\n ],\n \"bcc\": [\n \"string\"\n ],\n \"secureBody\": true,\n \"body\": \"string\",\n \"subject\": \"string\"\n }'" }, { "lang": "Python", "label": "Python", "source": "import requests\n\nid = \"VALUE\" # The unique identifier (UUID) of the entity.\n\nurl = f\"https://{{instance}}.kiteworks.com/rest/folders/{id}/actions/sendMessage\"\nheaders = {\n \"Authorization\": \"Bearer YOUR_TOKEN\",\n \"Content-Type\": \"application/json\",\n}\npayload = {\n \"to\": [\n \"string\"\n],\n \"cc\": [\n \"string\"\n],\n \"bcc\": [\n \"string\"\n],\n \"secureBody\": true,\n \"body\": \"string\",\n \"subject\": \"string\"\n}\nresponse = requests.post(url, headers=headers, json=payload)\nprint(response.json())" } ] } }, "/rest/folders/{id}/folders": { "get": { "tags": [ "folders" ], "summary": "List children folders of specified parent", "description": "Return the list of folders in the specified folder including its metadata.", "responses": { "200": { "description": "Returns a paginated list of child folders within the specified parent folder, including each folder's metadata.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Folder" } }, "metadata": { "$ref": "#/components/schemas/MetaData" } } }, "examples": { "FolderList": { "summary": "A page of child folders", "value": [ { "id": "abc12345def67890ab", "name": "Reports", "description": "Quarterly reports", "type": "d", "parent_id": "xyz98765cba43210fe", "deleted": false, "created": "2024-03-01T08:00:00+0000", "modified": "2024-06-15T14:22:00+0000", "syncable": false, "secure": false, "isFavorite": false, "isShared": true, "totalFilesCount": 12, "totalFoldersCount": 3, "totalMembersCount": 4, "avStatus": "clean", "dlpStatus": "clean" } ] } } } } }, "403": { "description": "Forbidden

Possible error codes: ERR_ACCESS_DLI_ADMIN", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Errors" }, "examples": { "ERR_ACCESS_DLI_ADMIN": { "summary": "Authenticated user is not a DLI Admin", "description": "Authenticated user is not a DLI Admin", "value": { "errors": { "code": "ERR_ACCESS_DLI_ADMIN", "message": "Authenticated user is not a DLI Admin" } } } } } } }, "490": { "description": "Request blocked by WAF" } }, "deprecated": false, "parameters": [ { "in": "path", "name": "id", "description": "ID of the parent folder", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "name", "description": "Folder name", "schema": { "type": "string" } }, { "in": "query", "name": "name:contains", "description": "Folder name. Search for results that contain the specified characters in this parameter.", "schema": { "type": "string" } }, { "in": "query", "name": "userId", "description": "Unique identifier of Object creator", "schema": { "type": "string" } }, { "in": "query", "name": "userId:in", "description": "Unique identifier of Object creator. Search for results that match any of the specified values for this parameter.", "schema": { "type": "string" } }, { "in": "query", "name": "created", "description": "Object creation date", "schema": { "type": "string", "format": "date" } }, { "in": "query", "name": "created:gt", "description": "Object creation date. Search for results where this parameter value is greater than the specified value.", "schema": { "type": "string", "format": "date" } }, { "in": "query", "name": "created:gte", "description": "Object creation date. Search for results where this parameter value is greater than or equal to the specified value.", "schema": { "type": "string", "format": "date" } }, { "in": "query", "name": "created:lt", "description": "Object creation date. Search for results where this parameter value is less than the specified value.", "schema": { "type": "string", "format": "date" } }, { "in": "query", "name": "created:lte", "description": "Object creation date. Search for results where this parameter value is less than or equal to the specified value.", "schema": { "type": "string", "format": "date" } }, { "in": "query", "name": "modified", "description": "Object modification date", "schema": { "type": "string", "format": "date" } }, { "in": "query", "name": "modified:gt", "description": "Object modification date. Search for results where this parameter value is greater than the specified value.", "schema": { "type": "string", "format": "date" } }, { "in": "query", "name": "modified:gte", "description": "Object modification date. Search for results where this parameter value is greater than or equal to the specified value.", "schema": { "type": "string", "format": "date" } }, { "in": "query", "name": "modified:lt", "description": "Object modification date. Search for results where this parameter value is less than the specified value.", "schema": { "type": "string", "format": "date" } }, { "in": "query", "name": "modified:lte", "description": "Object modification date. Search for results where this parameter value is less than or equal to the specified value.", "schema": { "type": "string", "format": "date" } }, { "in": "query", "name": "deleted", "description": "Indicates whether the object is deleted.", "schema": { "type": "boolean" } }, { "in": "query", "name": "expire", "description": "Expiration date", "schema": { "type": "integer" } }, { "in": "query", "name": "expire:gt", "description": "Expiration date. Search for results where this parameter value is greater than the specified value.", "schema": { "type": "integer" } }, { "in": "query", "name": "expire:gte", "description": "Expiration date. Search for results where this parameter value is greater than or equal to the specified value.", "schema": { "type": "integer" } }, { "in": "query", "name": "expire:lt", "description": "Expiration date. Search for results where this parameter value is less than the specified value.", "schema": { "type": "integer" } }, { "in": "query", "name": "expire:lte", "description": "Expiration date. Search for results where this parameter value is less than or equal to the specified value.", "schema": { "type": "integer" } }, { "in": "query", "name": "fileLifetime", "description": "Folder lifetime", "schema": { "type": "integer" } }, { "in": "query", "name": "fileLifetime:gt", "description": "Folder lifetime. Search for results where this parameter value is greater than the specified value.", "schema": { "type": "integer" } }, { "in": "query", "name": "fileLifetime:gte", "description": "Folder lifetime. Search for results where this parameter value is greater than or equal to the specified value.", "schema": { "type": "integer" } }, { "in": "query", "name": "fileLifetime:lt", "description": "Folder lifetime. Search for results where this parameter value is less than the specified value.", "schema": { "type": "integer" } }, { "in": "query", "name": "fileLifetime:lte", "description": "Folder lifetime. Search for results where this parameter value is less than or equal to the specified value.", "schema": { "type": "integer" } }, { "in": "query", "name": "secure", "description": "Folder secure flag", "schema": { "type": "boolean" } }, { "in": "query", "name": "description:contains", "description": "Folder description. Search for results that contain the specified characters in this parameter.", "schema": { "type": "string" } }, { "in": "query", "name": "orderBy", "description": "Sorting options", "schema": { "type": "array", "items": { "type": "string" }, "enum": [ "name:asc", "name:desc", "created:asc", "created:desc", "modified:asc", "modified:desc" ] } }, { "in": "query", "name": "offset", "description": "Offset", "schema": { "type": "integer" } }, { "in": "query", "name": "limit", "description": "Limit", "schema": { "type": "integer" } }, { "in": "query", "name": "locate_id", "description": "If specified, \"offset\" parameter will be ignored\n and the page containing entity with this Id will be returned.", "schema": { "type": "integer" } }, { "in": "query", "name": "with", "description": "With parameters", "schema": { "type": "string" } }, { "in": "query", "name": "mode", "description": "Determines the detail level of the response body.", "schema": { "type": "string", "enum": [ "full_with_links", "full", "compact" ] } } ], "x-codeSamples": [ { "lang": "Shell", "label": "cURL", "source": "curl -X GET \\\n \"https://{instance}.kiteworks.com/rest/folders/:id/folders\" \\\n -H \"Authorization: Bearer YOUR_TOKEN\"" }, { "lang": "Python", "label": "Python", "source": "import requests\n\nid = \"VALUE\" # ID of the parent folder\n\nurl = f\"https://{{instance}}.kiteworks.com/rest/folders/{id}/folders\"\nheaders = {\n \"Authorization\": \"Bearer YOUR_TOKEN\",\n}\nresponse = requests.get(url, headers=headers)\nprint(response.json())" } ] }, "post": { "summary": "Create a folder", "description": "### Description:\n Creates a new folder under the specified parent folder.\n### Precondition:\n User must have `folder_add` permission for the parent folder.\n### Response:\n The new folder is created and its details are returned.\n", "tags": [ "folders" ], "parameters": [ { "in": "path", "name": "id", "required": true, "description": "The unique identifier (UUID) of the entity.", "schema": { "type": "string", "format": "uuid" } }, { "in": "query", "name": "returnEntity", "required": false, "description": "If true, includes the entity in the response body.", "schema": { "type": "boolean" } }, { "in": "query", "name": "with", "required": false, "description": "Specifies additional fields to include in the response.", "schema": { "type": "string" } }, { "in": "query", "name": "mode", "required": false, "description": "Determines the detail level of the response body.", "schema": { "type": "string", "enum": [ "compact", "full_no_links", "full_with_links", "full" ] } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FolderCreatePostRequest" } } } }, "responses": { "201": { "description": "Folder created successfully.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Folder1" } } } }, "401": { "description": "Unauthorized

Possible error codes: ERR_AUTH_INVALID_CSRF, ERR_AUTH_UNAUTHORIZED", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Errors" }, "examples": { "ERR_AUTH_INVALID_CSRF": { "summary": "Invalid CSRF Authentication", "description": "Invalid CSRF Authentication", "value": { "errors": [ { "code": "ERR_AUTH_INVALID_CSRF", "message": "Invalid CSRF Authentication" } ] } }, "ERR_AUTH_UNAUTHORIZED": { "summary": "Unauthorized", "description": "Unauthorized", "value": { "errors": [ { "code": "ERR_AUTH_UNAUTHORIZED", "message": "Unauthorized" } ] } } } } } }, "403": { "description": "Forbidden

Possible error codes: ERR_ACCESS_DENIED, ERR_ACCESS_USER", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Errors" }, "examples": { "ERR_ACCESS_DENIED": { "summary": "Your access is denied.", "description": "Your access is denied.", "value": { "errors": [ { "code": "ERR_ACCESS_DENIED", "message": "Your access is denied.", "redirectUrl": "/login?code=3317" } ] } }, "ERR_ACCESS_USER": { "summary": "Insufficient access permissions", "description": "Insufficient access permissions", "value": { "errors": [ { "code": "ERR_ACCESS_USER", "message": "Insufficient access permissions" } ] } } } } } }, "409": { "description": "Conflict

Possible error codes: ERR_ENTITY_EXISTS", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Errors" }, "examples": { "ERR_ENTITY_EXISTS": { "summary": "Entity exists", "description": "Entity exists", "value": { "errors": [ { "code": "ERR_ENTITY_EXISTS", "message": "Entity exists" } ] } } } } } }, "490": { "description": "Request blocked by WAF" } }, "x-codeSamples": [ { "lang": "Shell", "label": "cURL", "source": "curl -X POST \\\n \"https://{instance}.kiteworks.com/rest/folders/:id/folders\" \\\n -H \"Authorization: Bearer YOUR_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"name\": \"string\",\n \"secure\": true,\n \"syncable\": true,\n \"expire\": \"2024-01-15\",\n \"fileLifetime\": 1,\n \"rename\": true\n }'" }, { "lang": "Python", "label": "Python", "source": "import requests\n\nid = \"VALUE\" # The unique identifier (UUID) of the entity.\n\nurl = f\"https://{{instance}}.kiteworks.com/rest/folders/{id}/folders\"\nheaders = {\n \"Authorization\": \"Bearer YOUR_TOKEN\",\n \"Content-Type\": \"application/json\",\n}\npayload = {\n \"name\": \"string\",\n \"secure\": true,\n \"syncable\": true,\n \"expire\": \"2024-01-15\",\n \"fileLifetime\": 1,\n \"rename\": true\n}\nresponse = requests.post(url, headers=headers, json=payload)\nprint(response.json())" } ] } }, "/rest/folders/{id}/members": { "get": { "summary": "List folder members.", "description": "### Description:\n Returns a paginated list of members who have access to the specified folder.\n### Precondition:\n User must have `user_view` permission for the folder.\n### Response:\n A list of folder members is returned.\n### Sorting:\n Sort string syntax `FIELD_NAME:ORDER`.\n\n ORDER can be `asc` or `desc`.\n### Sorting options:\n | FIELD_NAME | Description |\n |------------|-------------|\n | id | The member ID |\n | userId | The user ID |\n | groupId | The group ID |\n | roleId | The role ID |\n | rank | The rank of the role |\n | email | The member's email |\n", "tags": [ "folders" ], "parameters": [ { "in": "path", "name": "id", "required": true, "description": "The unique identifier (UUID) of the entity.", "schema": { "type": "string", "format": "uuid" } }, { "in": "query", "name": "email", "required": false, "description": "Filter results by email address.", "schema": { "type": "string" } }, { "in": "query", "name": "userId", "required": false, "description": "Filter results by user ID.", "schema": { "type": "string" } }, { "in": "query", "name": "groupId", "required": false, "description": "Filter results by group ID.", "schema": { "type": "integer" } }, { "in": "query", "name": "roleId", "required": false, "description": "Filter results by role ID.", "schema": { "type": "integer" } }, { "in": "query", "name": "userId:in", "required": false, "explode": true, "style": "form", "description": "Filter by a comma-separated list of user IDs. (Recommended request size <= 100)", "schema": { "type": "array", "items": { "type": "string" } } }, { "in": "query", "name": "groupId:in", "required": false, "explode": true, "style": "form", "description": "Filter by a comma-separated list of LDAP Group IDs. (Recommended request size <= 100)", "schema": { "type": "array", "items": { "type": "string" } } }, { "in": "query", "name": "roleId:in", "required": false, "explode": true, "style": "form", "description": "Filter by a comma-separated list of role IDs.", "schema": { "type": "array", "items": { "type": "string" } } }, { "in": "query", "name": "type", "required": false, "description": "Filter members by the object type they have access to.
`d` – Directory (folder) membership.
`f` – File membership.", "schema": { "type": "string", "enum": [ "d", "f" ] } }, { "in": "query", "name": "orderBy", "required": false, "description": "Sort order for the results. Default is `id:asc`.
Allowed values: `id:asc`, `id:desc`, `userId:asc`, `userId:desc`, `groupId:asc`, `groupId:desc`, `roleId:asc`, `roleId:desc`, `rank:asc`, `rank:desc`, `email:asc`, `email:desc`.", "schema": { "type": "string", "enum": [ "id:asc", "id:desc", "userId:asc", "userId:desc", "groupId:asc", "groupId:desc", "roleId:asc", "roleId:desc", "rank:asc", "rank:desc", "email:asc", "email:desc" ] } }, { "in": "query", "name": "limit", "required": false, "description": "Range limit.", "schema": { "type": "integer", "minimum": 1 } }, { "in": "query", "name": "offset", "required": false, "description": "Range offset.", "schema": { "type": "integer", "minimum": 0 } }, { "in": "query", "name": "with", "required": false, "description": "Specifies additional fields to include in the response.", "schema": { "type": "string" } }, { "in": "query", "name": "mode", "required": false, "description": "Determines the detail level of the response body.", "schema": { "type": "string", "enum": [ "compact", "full_no_links", "full_with_links", "full" ] } } ], "responses": { "200": { "description": "The folder members have been successfully returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Members" } } } }, "400": { "description": "Bad Request

Possible error codes: ERR_REQUEST_INVALID_JSON", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Errors" }, "examples": { "ERR_REQUEST_INVALID_JSON": { "summary": "Invalid json provided", "description": "Invalid json provided", "value": { "errors": [ { "code": "ERR_REQUEST_INVALID_JSON", "message": "Invalid json provided" } ] } } } } } }, "401": { "description": "Unauthorized

Possible error codes: ERR_AUTH_INVALID_CSRF, ERR_AUTH_UNAUTHORIZED", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Errors" }, "examples": { "ERR_AUTH_INVALID_CSRF": { "summary": "Invalid CSRF Authentication", "description": "Invalid CSRF Authentication", "value": { "errors": [ { "code": "ERR_AUTH_INVALID_CSRF", "message": "Invalid CSRF Authentication" } ] } }, "ERR_AUTH_UNAUTHORIZED": { "summary": "Unauthorized", "description": "Unauthorized", "value": { "errors": [ { "code": "ERR_AUTH_UNAUTHORIZED", "message": "Unauthorized" } ] } } } } } }, "403": { "description": "Forbidden

Possible error codes: ERR_SYSTEM_TENANT_SUSPENDED, ERR_ACCESS_USER, ERR_ACCESS_DENIED, ERR_ENTITY_DELETED", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Errors" }, "examples": { "ERR_SYSTEM_TENANT_SUSPENDED": { "summary": "Access to the service is restricted by the service provider. Contact your administrator for updates on restoring normal access.", "description": "Access to the service is restricted by the service provider. Contact your administrator for updates on restoring normal access.", "value": { "errors": [ { "code": "ERR_SYSTEM_TENANT_SUSPENDED", "message": "Access to the service is restricted by the service provider. Contact your administrator for updates on restoring normal access." } ] } }, "ERR_ACCESS_USER": { "summary": "Insufficient access permissions", "description": "Insufficient access permissions", "value": { "errors": [ { "code": "ERR_ACCESS_USER", "message": "Insufficient access permissions" } ] } }, "ERR_ACCESS_DENIED": { "summary": "Your access is denied.", "description": "Your access is denied.", "value": { "errors": [ { "code": "ERR_ACCESS_DENIED", "message": "Your access is denied.", "redirectUrl": "/login?code=3317" } ] } }, "ERR_ENTITY_DELETED": { "summary": "Entity is deleted", "description": "Entity is deleted", "value": { "errors": [ { "code": "ERR_ENTITY_DELETED", "message": "Entity is deleted" } ] } } } } } }, "422": { "description": "Unprocessable Content

Possible error codes: ERR_LICENSE_EXPIRED", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Errors" }, "examples": { "ERR_LICENSE_EXPIRED": { "summary": "License has expired", "description": "License has expired", "value": { "errors": [ { "code": "ERR_LICENSE_EXPIRED", "message": "License has expired" } ] } } } } } }, "490": { "description": "Request blocked by WAF" } }, "x-codeSamples": [ { "lang": "Shell", "label": "cURL", "source": "curl -X GET \\\n \"https://{instance}.kiteworks.com/rest/folders/:id/members\" \\\n -H \"Authorization: Bearer YOUR_TOKEN\"" }, { "lang": "Python", "label": "Python", "source": "import requests\n\nid = \"VALUE\" # The unique identifier (UUID) of the entity.\n\nurl = f\"https://{{instance}}.kiteworks.com/rest/folders/{id}/members\"\nheaders = {\n \"Authorization\": \"Bearer YOUR_TOKEN\",\n}\nresponse = requests.get(url, headers=headers)\nprint(response.json())" } ] }, "post": { "summary": "Add members to a folder", "description": "### Description:\n Adds one or more users or LDAP groups as members of the specified folder.\n### Precondition:\n User must have `user_add` permission for the folder.\n### Response:\n The new members are added to the folder.\n", "tags": [ "folders" ], "parameters": [ { "in": "path", "name": "id", "required": true, "description": "The unique identifier (UUID) of the entity.", "schema": { "type": "string", "format": "uuid" } }, { "in": "query", "name": "updateIfExists", "required": false, "description": "If set to `true`, updates the member if they already exist and have a different folder role.", "schema": { "type": "boolean" } }, { "in": "query", "name": "partialSuccess", "required": false, "description": "If set to `true`, the operation will continue for the valid items even if some items result in failure.", "schema": { "type": "boolean" } }, { "in": "query", "name": "downgradeNested", "required": false, "description": "If set to `true`, demote the user member role in all applicable nested folders.", "schema": { "type": "boolean" } }, { "in": "query", "name": "returnEntity", "required": false, "description": "If true, includes the entity in the response body.", "schema": { "type": "boolean" } }, { "in": "query", "name": "with", "required": false, "description": "Specifies additional fields to include in the response.", "schema": { "type": "string" } }, { "in": "query", "name": "mode", "required": false, "description": "Determines the detail level of the response body.", "schema": { "type": "string", "enum": [ "compact", "full_no_links", "full_with_links", "full" ] } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FolderMemberPostRequest" } } } }, "responses": { "201": { "description": "Members were added successfully.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FolderFileAddMembers" } } } }, "207": { "description": "Some members were added successfully, while others failed.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FolderFileAddMembers" } } } }, "401": { "description": "Unauthorized

Possible error codes: ERR_AUTH_INVALID_CSRF, ERR_AUTH_UNAUTHORIZED", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Errors" }, "examples": { "ERR_AUTH_INVALID_CSRF": { "summary": "Invalid CSRF Authentication", "description": "Invalid CSRF Authentication", "value": { "errors": [ { "code": "ERR_AUTH_INVALID_CSRF", "message": "Invalid CSRF Authentication" } ] } }, "ERR_AUTH_UNAUTHORIZED": { "summary": "Unauthorized", "description": "Unauthorized", "value": { "errors": [ { "code": "ERR_AUTH_UNAUTHORIZED", "message": "Unauthorized" } ] } } } } } }, "403": { "description": "Forbidden

Possible error codes: ERR_ENTITY_IS_BASE_DIR, ERR_ENTITY_IS_MY_DIR, ERR_ENTITY_IS_SYNC_DIR, ERR_ACCESS_USER, ERR_LICENSE_MAX_USERS_COUNT_REACHED, ERR_USER_HAS_NO_USER_TYPE, ERR_USER_TYPE_NO_ACCESS, ERR_INPUT_EMAIL_IS_DISTRIBUTION_LIST, ERR_ENTITY_USER_HAS_INSUFFICIENT_PERMISSIONS, ERR_PROFILE_COLLABORATION_DISABLED, ERR_ENTITY_IS_OWNER, ERR_ENTITY_DELETED, ERR_CLIENT_OBJECT, ERR_PROFILE_SALESFORCE_OBJECT_DISABLED, ERR_PROFILE_SALESFORCE_OBJECT_ROLE_DISALLOWED", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Errors" }, "examples": { "ERR_ENTITY_IS_BASE_DIR": { "summary": "Operation not permitted on Base Folder", "description": "Operation not permitted on Base Folder", "value": { "errors": [ { "code": "ERR_ENTITY_IS_BASE_DIR", "message": "Operation not permitted on Base Folder" } ] } }, "ERR_ENTITY_IS_MY_DIR": { "summary": "Operation not permitted on Tray Folder", "description": "Operation not permitted on Tray Folder", "value": { "errors": [ { "code": "ERR_ENTITY_IS_MY_DIR", "message": "Operation not permitted on Tray Folder" } ] } }, "ERR_ENTITY_IS_SYNC_DIR": { "summary": "Operation not permitted on My Folder", "description": "Operation not permitted on My Folder", "value": { "errors": [ { "code": "ERR_ENTITY_IS_SYNC_DIR", "message": "Operation not permitted on My Folder" } ] } }, "ERR_ACCESS_USER": { "summary": "Insufficient access permissions", "description": "Insufficient access permissions", "value": { "errors": [ { "code": "ERR_ACCESS_USER", "message": "Insufficient access permissions" } ] } }, "ERR_LICENSE_MAX_USERS_COUNT_REACHED": { "summary": "License count has been reached", "description": "License count has been reached", "value": { "errors": [ { "code": "ERR_LICENSE_MAX_USERS_COUNT_REACHED", "message": "License count has been reached" } ] } }, "ERR_USER_HAS_NO_USER_TYPE": { "summary": "User has no profile", "description": "User has no profile", "value": { "errors": [ { "code": "ERR_USER_HAS_NO_USER_TYPE", "message": "User has no profile" } ] } }, "ERR_USER_TYPE_NO_ACCESS": { "summary": "Permission denied", "description": "Permission denied", "value": { "errors": [ { "code": "ERR_USER_TYPE_NO_ACCESS", "message": "Permission denied" } ] } }, "ERR_INPUT_EMAIL_IS_DISTRIBUTION_LIST": { "summary": "Distribution list user is not allowed to register", "description": "Distribution list user is not allowed to register", "value": { "errors": [ { "code": "ERR_INPUT_EMAIL_IS_DISTRIBUTION_LIST", "message": "Distribution list user is not allowed to register" } ] } }, "ERR_ENTITY_USER_HAS_INSUFFICIENT_PERMISSIONS": { "summary": "Target user has insufficient access permissions", "description": "Target user has insufficient access permissions", "value": { "errors": [ { "code": "ERR_ENTITY_USER_HAS_INSUFFICIENT_PERMISSIONS", "message": "Target user has insufficient access permissions" } ] } }, "ERR_PROFILE_COLLABORATION_DISABLED": { "summary": "User's profile has no collaboration access", "description": "User's profile has no collaboration access", "value": { "errors": [ { "code": "ERR_PROFILE_COLLABORATION_DISABLED", "message": "User's profile has no collaboration access" } ] } }, "ERR_ENTITY_IS_OWNER": { "summary": "Operation not permitted on owner member", "description": "Operation not permitted on owner member", "value": { "errors": [ { "code": "ERR_ENTITY_IS_OWNER", "message": "Operation not permitted on owner member" } ] } }, "ERR_ENTITY_DELETED": { "summary": "Entity is deleted", "description": "Entity is deleted", "value": { "errors": [ { "code": "ERR_ENTITY_DELETED", "message": "Entity is deleted" } ] } }, "ERR_CLIENT_OBJECT": { "summary": "Operation is not allowed on this client object", "description": "Operation is not allowed on this client object", "value": { "errors": [ { "code": "ERR_CLIENT_OBJECT", "message": "Operation is not allowed on this client object" } ] } }, "ERR_PROFILE_SALESFORCE_OBJECT_DISABLED": { "summary": "This Salesforce object is not enabled for this profile", "description": "This Salesforce object is not enabled for this profile", "value": { "errors": [ { "code": "ERR_PROFILE_SALESFORCE_OBJECT_DISABLED", "message": "This Salesforce object is not enabled for this profile" } ] } }, "ERR_PROFILE_SALESFORCE_OBJECT_ROLE_DISALLOWED": { "summary": "This role is disallowed for this Salesforce object", "description": "This role is disallowed for this Salesforce object", "value": { "errors": [ { "code": "ERR_PROFILE_SALESFORCE_OBJECT_ROLE_DISALLOWED", "message": "This role is disallowed for this Salesforce object" } ] } } } } } }, "409": { "description": "Conflict

Possible error codes: ERR_ENTITY_EXISTS, ERR_ENTITY_ROLE_IS_ASSIGNED, ERR_ENTITY_PARENT_FOLDER_MEMBER_EXISTS", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Errors" }, "examples": { "ERR_ENTITY_EXISTS": { "summary": "Entity exists", "description": "Entity exists", "value": { "errors": [ { "code": "ERR_ENTITY_EXISTS", "message": "Entity exists" } ] } }, "ERR_ENTITY_ROLE_IS_ASSIGNED": { "summary": "Cannot assign already assigned role", "description": "Cannot assign already assigned role", "value": { "errors": [ { "code": "ERR_ENTITY_ROLE_IS_ASSIGNED", "message": "Cannot assign already assigned role" } ] } }, "ERR_ENTITY_PARENT_FOLDER_MEMBER_EXISTS": { "summary": "Parent folder member exists", "description": "Parent folder member exists", "value": { "errors": [ { "code": "ERR_ENTITY_PARENT_FOLDER_MEMBER_EXISTS", "message": "Parent folder member exists" } ] } } } } } }, "490": { "description": "Request blocked by WAF" } }, "x-codeSamples": [ { "lang": "Shell", "label": "cURL", "source": "curl -X POST \\\n \"https://{instance}.kiteworks.com/rest/folders/:id/members\" \\\n -H \"Authorization: Bearer YOUR_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"notify\": true,\n \"emails\": [\n \"string\"\n ],\n \"userIds\": [\n \"string\"\n ],\n \"ldapGroupIds\": [\n 1\n ],\n \"roleId\": 1,\n \"notifyFileAdded\": true\n }'" }, { "lang": "Python", "label": "Python", "source": "import requests\n\nid = \"VALUE\" # The unique identifier (UUID) of the entity.\n\nurl = f\"https://{{instance}}.kiteworks.com/rest/folders/{id}/members\"\nheaders = {\n \"Authorization\": \"Bearer YOUR_TOKEN\",\n \"Content-Type\": \"application/json\",\n}\npayload = {\n \"notify\": true,\n \"emails\": [\n \"string\"\n],\n \"userIds\": [\n \"string\"\n],\n \"ldapGroupIds\": [\n 1\n],\n \"roleId\": 1,\n \"notifyFileAdded\": true\n}\nresponse = requests.post(url, headers=headers, json=payload)\nprint(response.json())" } ] } }, "/rest/folders/{id}/members/ldapGroup": { "get": { "tags": [ "folders" ], "summary": "List LDAP groups with access to a folder", "description": "Returns a list of LDAP groups and their assigned roles for the specified folder.", "responses": { "200": { "description": "Returns a paginated list of LDAP groups that have been granted access to the specified folder, including each group's assigned role.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/MemberGroup" } }, "metadata": { "$ref": "#/components/schemas/MetaData" } } }, "examples": { "FolderGroupList": { "summary": "A page of LDAP group access grants", "value": [ { "objectId": "abc12345def67890ab", "groupId": 42, "roleId": 3 } ] } } } } }, "490": { "description": "Request blocked by WAF" } }, "deprecated": false, "parameters": [ { "in": "path", "name": "id", "description": "The unique identifier (UUID) of the folder.", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "groupId", "description": "The unique identifier of the group.", "schema": { "type": "integer" } }, { "in": "query", "name": "groupId:in", "description": "The unique identifier of the group.. Search for results that match any of the specified values for this parameter.", "schema": { "type": "integer" } }, { "in": "query", "name": "roleId", "description": "The unique identifier of the role.", "schema": { "type": "integer" } }, { "in": "query", "name": "roleId:in", "description": "The unique identifier of the role.. Search for results that match any of the specified values for this parameter.", "schema": { "type": "integer" } }, { "in": "query", "name": "orderBy", "description": "Sorting options", "schema": { "type": "array", "items": { "type": "string" }, "enum": [ "id:asc", "id:desc", "groupId:asc", "groupId:desc", "roleId:asc", "roleId:desc" ] } }, { "in": "query", "name": "offset", "description": "Offset", "schema": { "type": "integer" } }, { "in": "query", "name": "limit", "description": "Limit", "schema": { "type": "integer" } }, { "in": "query", "name": "with", "description": "With parameters", "schema": { "type": "string" } }, { "in": "query", "name": "mode", "description": "Determines the detail level of the response body.", "schema": { "type": "string", "enum": [ "full_with_links", "full", "compact" ] } } ], "x-codeSamples": [ { "lang": "Shell", "label": "cURL", "source": "curl -X GET \\\n \"https://{instance}.kiteworks.com/rest/folders/:id/members/ldapGroup\" \\\n -H \"Authorization: Bearer YOUR_TOKEN\"" }, { "lang": "Python", "label": "Python", "source": "import requests\n\nid = \"VALUE\" # The unique identifier (UUID) of the folder.\n\nurl = f\"https://{{instance}}.kiteworks.com/rest/folders/{id}/members/ldapGroup\"\nheaders = {\n \"Authorization\": \"Bearer YOUR_TOKEN\",\n}\nresponse = requests.get(url, headers=headers)\nprint(response.json())" } ] } }, "/rest/folders/{id}/members/ldapGroup/{ldap_group_id}": { "get": { "tags": [ "folders" ], "summary": "Return a specific LDAP group's access to a folder", "description": "Returns the access grant record for the specified LDAP group in the folder, including the group's assigned role.", "responses": { "200": { "description": "Returns the access grant record for the specified LDAP group, including its assigned role in the folder.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MemberGroup" }, "examples": { "FolderGroupMember": { "summary": "LDAP group with editor role", "value": { "objectId": "abc12345def67890ab", "groupId": 42, "roleId": 3 } } } } } }, "490": { "description": "Request blocked by WAF" } }, "deprecated": false, "parameters": [ { "in": "path", "name": "id", "description": "The unique identifier (UUID) of the folder.", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "ldap_group_id", "description": "The unique identifier of the LDAP group member", "required": true, "schema": { "type": "integer" } }, { "in": "query", "name": "with", "description": "With parameters", "schema": { "type": "string" } }, { "in": "query", "name": "mode", "description": "Determines the detail level of the response body.", "schema": { "type": "string", "enum": [ "full_with_links", "full", "compact" ] } } ], "x-codeSamples": [ { "lang": "Shell", "label": "cURL", "source": "curl -X GET \\\n \"https://{instance}.kiteworks.com/rest/folders/:id/members/ldapGroup/:ldap_group_id\" \\\n -H \"Authorization: Bearer YOUR_TOKEN\"" }, { "lang": "Python", "label": "Python", "source": "import requests\n\nid = \"VALUE\" # The unique identifier (UUID) of the folder.\nldap_group_id = \"VALUE\" # The unique identifier of the LDAP group member\n\nurl = f\"https://{{instance}}.kiteworks.com/rest/folders/{id}/members/ldapGroup/{ldap_group_id}\"\nheaders = {\n \"Authorization\": \"Bearer YOUR_TOKEN\",\n}\nresponse = requests.get(url, headers=headers)\nprint(response.json())" } ] }, "put": { "tags": [ "folders" ], "summary": "Update folder LDAP group members", "description": "Updates LDAP group members within the folder", "responses": { "200": { "description": "Returns the updated LDAP group access records reflecting the new role assignment.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/MemberGroup" } }, "metadata": { "$ref": "#/components/schemas/MetaData" } } }, "examples": { "UpdatedGroupMember": { "summary": "LDAP group role updated to viewer", "value": [ { "objectId": "abc12345def67890ab", "groupId": 42, "roleId": 4 } ] } } } } }, "403": { "description": "Forbidden

Possible error codes: ERR_ACCESS_USER", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Errors" }, "examples": { "ERR_ACCESS_USER": { "summary": "Insufficient access permissions", "description": "Insufficient access permissions", "value": { "errors": { "code": "ERR_ACCESS_USER", "message": "Insufficient access permissions" } } } } } } }, "422": { "description": "Unprocessable Content

Possible error codes: ERR_INPUT_REQUIRED", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Errors" }, "examples": { "ERR_INPUT_REQUIRED": { "summary": "Field is required", "description": "Field is required", "value": { "errors": { "code": "ERR_INPUT_REQUIRED", "message": "Field is required" } } } } } } }, "490": { "description": "Request blocked by WAF" } }, "deprecated": false, "parameters": [ { "in": "path", "name": "id", "description": "The unique identifier (UUID) of the folder.", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "ldap_group_id", "description": "The unique identifier (UUID) of the LDAP group member.", "required": true, "schema": { "type": "integer" } }, { "in": "query", "name": "returnEntity", "description": "If set to `true`, returns information about the newly created entity.", "schema": { "type": "boolean" } }, { "in": "query", "name": "downgradeNested", "description": "Also downgrade the member role for nested folders.", "schema": { "type": "boolean" } }, { "in": "query", "name": "mode", "description": "Determines the detail level of the response body.", "schema": { "type": "string", "enum": [ "full_with_links", "full" ] } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MemberGroup.Put" } } } }, "x-codeSamples": [ { "lang": "Shell", "label": "cURL", "source": "curl -X PUT \\\n \"https://{instance}.kiteworks.com/rest/folders/:id/members/ldapGroup/:ldap_group_id\" \\\n -H \"Authorization: Bearer YOUR_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"roleId\": 1,\n \"notifyFileAdded\": true,\n \"addLinks\": true\n }'" }, { "lang": "Python", "label": "Python", "source": "import requests\n\nid = \"VALUE\" # The unique identifier (UUID) of the folder.\nldap_group_id = \"VALUE\" # The unique identifier (UUID) of the LDAP group member.\n\nurl = f\"https://{{instance}}.kiteworks.com/rest/folders/{id}/members/ldapGroup/{ldap_group_id}\"\nheaders = {\n \"Authorization\": \"Bearer YOUR_TOKEN\",\n \"Content-Type\": \"application/json\",\n}\npayload = {\n \"roleId\": 1,\n \"notifyFileAdded\": true,\n \"addLinks\": true\n}\nresponse = requests.put(url, headers=headers, json=payload)\nprint(response.json())" } ] }, "delete": { "summary": "Delete a folder LDAP group member", "description": "### Description:\nRemoves an LDAP member from the specified folder.\n\n### Precondition:\nThe user must have the `user_remove` permission for the folder.\n\n### Response:\nThe specified folder LDAP group member is successfully removed.\n", "tags": [ "folders" ], "parameters": [ { "in": "path", "name": "id", "required": true, "description": "The unique identifier (UUID) of the entity.", "schema": { "type": "string", "format": "uuid" } }, { "in": "path", "name": "ldap_group_id", "required": true, "description": "The unique identifier of the LDAP group.", "schema": { "type": "integer" } }, { "in": "query", "name": "downgradeNested", "required": false, "description": "If set to `true`, the user's role will be removed from all nested folders.", "schema": { "type": "boolean" } } ], "responses": { "204": { "description": "The folder LDAP group member was successfully removed from the folder." }, "401": { "description": "Unauthorized

Possible error codes: ERR_AUTH_INVALID_CSRF, ERR_AUTH_UNAUTHORIZED", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Errors" }, "examples": { "ERR_AUTH_INVALID_CSRF": { "summary": "Invalid CSRF Authentication", "description": "Invalid CSRF Authentication", "value": { "errors": [ { "code": "ERR_AUTH_INVALID_CSRF", "message": "Invalid CSRF Authentication" } ] } }, "ERR_AUTH_UNAUTHORIZED": { "summary": "Unauthorized", "description": "Unauthorized", "value": { "errors": [ { "code": "ERR_AUTH_UNAUTHORIZED", "message": "Unauthorized" } ] } } } } } }, "403": { "description": "Forbidden

Possible error codes: ERR_ACCESS_USER, ERR_ENTITY_DELETED, ERR_INPUT_IS_OWNER, ERR_ENTITY_PARENT_FOLDER_MEMBER_EXISTS", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Errors" }, "examples": { "ERR_ACCESS_USER": { "summary": "Insufficient access permissions", "description": "Insufficient access permissions", "value": { "errors": [ { "code": "ERR_ACCESS_USER", "message": "Insufficient access permissions" } ] } }, "ERR_ENTITY_DELETED": { "summary": "Entity is deleted", "description": "Entity is deleted", "value": { "errors": [ { "code": "ERR_ENTITY_DELETED", "message": "Entity is deleted" } ] } }, "ERR_INPUT_IS_OWNER": { "summary": "Can not set owner role", "description": "Can not set owner role", "value": { "errors": [ { "code": "ERR_INPUT_IS_OWNER", "message": "Can not set owner role" } ] } }, "ERR_ENTITY_PARENT_FOLDER_MEMBER_EXISTS": { "summary": "Parent folder member exists", "description": "Parent folder member exists", "value": { "errors": [ { "code": "ERR_ENTITY_PARENT_FOLDER_MEMBER_EXISTS", "message": "Parent folder member exists" } ] } } } } } }, "422": { "description": "Unprocessable Content

Possible error codes: ERR_INVALID_PARAMETER", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Errors" }, "examples": { "ERR_INVALID_PARAMETER": { "summary": "Invalid Parameter Exception", "description": "Invalid Parameter Exception", "value": { "errors": [ { "code": "ERR_INVALID_PARAMETER", "message": "Invalid Parameter Exception" } ] } } } } } }, "490": { "description": "Request blocked by WAF" } }, "x-codeSamples": [ { "lang": "Shell", "label": "cURL", "source": "curl -X DELETE \\\n \"https://{instance}.kiteworks.com/rest/folders/:id/members/ldapGroup/:ldap_group_id\" \\\n -H \"Authorization: Bearer YOUR_TOKEN\"" }, { "lang": "Python", "label": "Python", "source": "import requests\n\nid = \"VALUE\" # The unique identifier (UUID) of the entity.\nldap_group_id = \"VALUE\" # The unique identifier of the LDAP group.\n\nurl = f\"https://{{instance}}.kiteworks.com/rest/folders/{id}/members/ldapGroup/{ldap_group_id}\"\nheaders = {\n \"Authorization\": \"Bearer YOUR_TOKEN\",\n}\nresponse = requests.delete(url, headers=headers)\nprint(response.json())" } ] } }, "/rest/folders/{id}/members/{member_user_id}": { "get": { "tags": [ "folders" ], "summary": "Return folder user member", "description": "Returns the specified user member within the folder.", "responses": { "200": { "description": "Returns the specified user member and their role within the folder.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Member" }, "examples": { "FolderMember": { "summary": "User member with editor role", "value": { "objectId": "abc12345def67890ab", "userId": "usr98765cba43210fe", "roleId": 3 } } } } } }, "490": { "description": "Request blocked by WAF" } }, "deprecated": false, "parameters": [ { "in": "path", "name": "id", "description": "The unique identifier (UUID) of the folder.", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "member_user_id", "description": "The unique identifier (UUID) of the user member.", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "with", "description": "With parameters", "schema": { "type": "string" } }, { "in": "query", "name": "mode", "description": "Determines the detail level of the response body.", "schema": { "type": "string", "enum": [ "full_with_links", "full", "compact" ] } } ], "x-codeSamples": [ { "lang": "Shell", "label": "cURL", "source": "curl -X GET \\\n \"https://{instance}.kiteworks.com/rest/folders/:id/members/:member_user_id\" \\\n -H \"Authorization: Bearer YOUR_TOKEN\"" }, { "lang": "Python", "label": "Python", "source": "import requests\n\nid = \"VALUE\" # The unique identifier (UUID) of the folder.\nmember_user_id = \"VALUE\" # The unique identifier (UUID) of the user member.\n\nurl = f\"https://{{instance}}.kiteworks.com/rest/folders/{id}/members/{member_user_id}\"\nheaders = {\n \"Authorization\": \"Bearer YOUR_TOKEN\",\n}\nresponse = requests.get(url, headers=headers)\nprint(response.json())" } ] }, "put": { "tags": [ "folders" ], "summary": "Update folder user members", "description": "Updates the user members within the folder.", "responses": { "200": { "description": "Returns the updated member records reflecting the new role assignment.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Member" } }, "metadata": { "$ref": "#/components/schemas/MetaData" } } }, "examples": { "UpdatedMember": { "summary": "Member role updated to viewer", "value": [ { "objectId": "abc12345def67890ab", "userId": "usr98765cba43210fe", "roleId": 4 } ] } } } } }, "403": { "description": "Forbidden

Possible error codes: ERR_ACCESS_USER", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Errors" }, "examples": { "ERR_ACCESS_USER": { "summary": "Insufficient access permissions", "description": "Insufficient access permissions", "value": { "errors": { "code": "ERR_ACCESS_USER", "message": "Insufficient access permissions" } } } } } } }, "422": { "description": "Unprocessable Content

Possible error codes: ERR_INPUT_REQUIRED, ERR_INPUT_INVALID_EMAIL", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Errors" }, "examples": { "ERR_INPUT_REQUIRED": { "summary": "Field is required", "description": "Field is required", "value": { "errors": { "code": "ERR_INPUT_REQUIRED", "message": "Field is required" } } }, "ERR_INPUT_INVALID_EMAIL": { "summary": "Input is not a valid email", "description": "Input is not a valid email", "value": { "errors": { "code": "ERR_INPUT_INVALID_EMAIL", "message": "Input is not a valid email" } } } } } } }, "490": { "description": "Request blocked by WAF" } }, "deprecated": false, "parameters": [ { "in": "path", "name": "id", "description": "The unique identifier (UUID) of the folder.", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "member_user_id", "description": "The unique identifier of the user member.", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "returnEntity", "description": "If set to `true`, returns information about the newly created entity.", "schema": { "type": "boolean" } }, { "in": "query", "name": "downgradeNested", "description": "Also downgrade the member role for nested folders.", "schema": { "type": "boolean" } }, { "in": "query", "name": "mode", "description": "Determines the detail level of the response body.", "schema": { "type": "string", "enum": [ "full_with_links", "full" ] } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Member.Put" } } } }, "x-codeSamples": [ { "lang": "Shell", "label": "cURL", "source": "curl -X PUT \\\n \"https://{instance}.kiteworks.com/rest/folders/:id/members/:member_user_id\" \\\n -H \"Authorization: Bearer YOUR_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"roleId\": 1,\n \"notifyFileAdded\": true,\n \"addLinks\": true,\n \"notify\": true\n }'" }, { "lang": "Python", "label": "Python", "source": "import requests\n\nid = \"VALUE\" # The unique identifier (UUID) of the folder.\nmember_user_id = \"VALUE\" # The unique identifier of the user member.\n\nurl = f\"https://{{instance}}.kiteworks.com/rest/folders/{id}/members/{member_user_id}\"\nheaders = {\n \"Authorization\": \"Bearer YOUR_TOKEN\",\n \"Content-Type\": \"application/json\",\n}\npayload = {\n \"roleId\": 1,\n \"notifyFileAdded\": true,\n \"addLinks\": true,\n \"notify\": true\n}\nresponse = requests.put(url, headers=headers, json=payload)\nprint(response.json())" } ] }, "delete": { "summary": "Delete a folder member", "description": "### Description:\nRemoves a member from the specified folder.\n\n### Precondition:\nThe user must have the `user_remove` permission for the folder.\n\n### Response:\nThe specified folder member is successfully removed.\n", "tags": [ "folders" ], "parameters": [ { "in": "path", "name": "id", "required": true, "description": "The unique identifier (UUID) of the entity.", "schema": { "type": "string", "format": "uuid" } }, { "in": "path", "name": "member_user_id", "required": true, "description": "The unique identifier (UUID) of the user.", "schema": { "type": "string", "format": "uuid" } }, { "in": "query", "name": "downgradeNested", "required": false, "description": "If set to `true`, the user's role will be removed from all nested folders.", "schema": { "type": "boolean" } } ], "responses": { "204": { "description": "The folder member was successfully removed from the folder." }, "401": { "description": "Unauthorized

Possible error codes: ERR_AUTH_INVALID_CSRF, ERR_AUTH_UNAUTHORIZED", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Errors" }, "examples": { "ERR_AUTH_INVALID_CSRF": { "summary": "Invalid CSRF Authentication", "description": "Invalid CSRF Authentication", "value": { "errors": [ { "code": "ERR_AUTH_INVALID_CSRF", "message": "Invalid CSRF Authentication" } ] } }, "ERR_AUTH_UNAUTHORIZED": { "summary": "Unauthorized", "description": "Unauthorized", "value": { "errors": [ { "code": "ERR_AUTH_UNAUTHORIZED", "message": "Unauthorized" } ] } } } } } }, "403": { "description": "Forbidden

Possible error codes: ERR_ACCESS_USER, ERR_ENTITY_DELETED, ERR_INPUT_IS_OWNER, ERR_ENTITY_PARENT_FOLDER_MEMBER_EXISTS, ERR_ENTITY_INHERITED_MEMBER_NOT_MODIFIABLE", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Errors" }, "examples": { "ERR_ACCESS_USER": { "summary": "Insufficient access permissions", "description": "Insufficient access permissions", "value": { "errors": [ { "code": "ERR_ACCESS_USER", "message": "Insufficient access permissions" } ] } }, "ERR_ENTITY_DELETED": { "summary": "Entity is deleted", "description": "Entity is deleted", "value": { "errors": [ { "code": "ERR_ENTITY_DELETED", "message": "Entity is deleted" } ] } }, "ERR_INPUT_IS_OWNER": { "summary": "Can not set owner role", "description": "Can not set owner role", "value": { "errors": [ { "code": "ERR_INPUT_IS_OWNER", "message": "Can not set owner role" } ] } }, "ERR_ENTITY_PARENT_FOLDER_MEMBER_EXISTS": { "summary": "Parent folder member exists", "description": "Parent folder member exists", "value": { "errors": [ { "code": "ERR_ENTITY_PARENT_FOLDER_MEMBER_EXISTS", "message": "Parent folder member exists" } ] } }, "ERR_ENTITY_INHERITED_MEMBER_NOT_MODIFIABLE": { "summary": "Cannot modify an inherited member at this folder. Make the change at the origin folder.", "description": "Cannot modify an inherited member at this folder. Make the change at the origin folder.", "value": { "errors": [ { "code": "ERR_ENTITY_INHERITED_MEMBER_NOT_MODIFIABLE", "message": "Cannot modify an inherited member at this folder. Make the change at the origin folder." } ] } } } } } }, "422": { "description": "Unprocessable Content

Possible error codes: ERR_INVALID_PARAMETER", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Errors" }, "examples": { "ERR_INVALID_PARAMETER": { "summary": "Invalid Parameter Exception", "description": "Invalid Parameter Exception", "value": { "errors": [ { "code": "ERR_INVALID_PARAMETER", "message": "Invalid Parameter Exception" } ] } } } } } }, "490": { "description": "Request blocked by WAF" } }, "x-codeSamples": [ { "lang": "Shell", "label": "cURL", "source": "curl -X DELETE \\\n \"https://{instance}.kiteworks.com/rest/folders/:id/members/:member_user_id\" \\\n -H \"Authorization: Bearer YOUR_TOKEN\"" }, { "lang": "Python", "label": "Python", "source": "import requests\n\nid = \"VALUE\" # The unique identifier (UUID) of the entity.\nmember_user_id = \"VALUE\" # The unique identifier (UUID) of the user.\n\nurl = f\"https://{{instance}}.kiteworks.com/rest/folders/{id}/members/{member_user_id}\"\nheaders = {\n \"Authorization\": \"Bearer YOUR_TOKEN\",\n}\nresponse = requests.delete(url, headers=headers)\nprint(response.json())" } ] } }, "/rest/folders/{id}/tasks": { "get": { "tags": [ "folders", "tasks" ], "summary": "Get tasks for a folder", "description": "Gets a list of tasks associated with all files in the specified folder. **Requires `task_view` permission on the folder.**", "responses": { "200": { "description": "Returns a paginated list of tasks for all files within the specified folder.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Task" } }, "metadata": { "$ref": "#/components/schemas/MetaData" } } }, "examples": { "Folder task list": { "summary": "A paginated list of tasks across files in a folder", "value": { "data": [ { "id": 15, "object_id": 7, "parent_id": 0, "user_id": 3, "assignee_id": 5, "contents": "Review the quarterly report for accuracy.", "status": "P", "due": "2024-04-01T00:00:00+00:00", "created": "2024-03-15T10:00:00+00:00", "modified": "2024-03-16T08:30:00+00:00", "deleted": false, "folder_id": 3 }, { "id": 16, "object_id": 8, "parent_id": 0, "user_id": 3, "assignee_id": 3, "contents": "Update the budget spreadsheet with Q1 actuals.", "status": "D", "due": "2024-04-15T00:00:00+00:00", "created": "2024-03-16T09:00:00+00:00", "modified": "2024-03-16T09:00:00+00:00", "deleted": false, "folder_id": 3 } ], "total": 2, "page": 1, "pageSize": 20 } } } } } }, "490": { "description": "Request blocked by WAF" } }, "deprecated": false, "parameters": [ { "in": "path", "name": "id", "description": "The unique identifier (UUID) of the folder.", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "assigneeId", "description": "Assigned User unique identifier", "schema": { "type": "string" } }, { "in": "query", "name": "assigneeId:in", "description": "Assigned User unique identifier. Search for results that match any of the specified values for this parameter.", "schema": { "type": "string" } }, { "in": "query", "name": "due", "description": "Task due date", "schema": { "type": "string", "format": "date" } }, { "in": "query", "name": "due:gt", "description": "Task due date. Search for results where this parameter value is greater than the specified value.", "schema": { "type": "string", "format": "date" } }, { "in": "query", "name": "due:gte", "description": "Task due date. Search for results where this parameter value is greater than or equal to the specified value.", "schema": { "type": "string", "format": "date" } }, { "in": "query", "name": "due:lt", "description": "Task due date. Search for results where this parameter value is less than the specified value.", "schema": { "type": "string", "format": "date" } }, { "in": "query", "name": "due:lte", "description": "Task due date. Search for results where this parameter value is less than or equal to the specified value.", "schema": { "type": "string", "format": "date" } }, { "in": "query", "name": "parentId", "description": "Parent Comment identifier", "schema": { "type": "integer" } }, { "in": "query", "name": "parentId:in", "description": "Parent Comment identifier. Search for results that match any of the specified values for this parameter.", "schema": { "type": "integer" } }, { "in": "query", "name": "userId", "description": "Identifier of User who created a Task", "schema": { "type": "string" } }, { "in": "query", "name": "userId:in", "description": "Identifier of User who created a Task. Search for results that match any of the specified values for this parameter.", "schema": { "type": "string" } }, { "in": "query", "name": "created", "description": "Task creation date", "schema": { "type": "string", "format": "date" } }, { "in": "query", "name": "created:gt", "description": "Task creation date. Search for results where this parameter value is greater than the specified value.", "schema": { "type": "string", "format": "date" } }, { "in": "query", "name": "created:gte", "description": "Task creation date. Search for results where this parameter value is greater than or equal to the specified value.", "schema": { "type": "string", "format": "date" } }, { "in": "query", "name": "created:lt", "description": "Task creation date. Search for results where this parameter value is less than the specified value.", "schema": { "type": "string", "format": "date" } }, { "in": "query", "name": "created:lte", "description": "Task creation date. Search for results where this parameter value is less than or equal to the specified value.", "schema": { "type": "string", "format": "date" } }, { "in": "query", "name": "modified", "description": "Task modification date", "schema": { "type": "string", "format": "date" } }, { "in": "query", "name": "modified:gt", "description": "Task modification date. Search for results where this parameter value is greater than the specified value.", "schema": { "type": "string", "format": "date" } }, { "in": "query", "name": "modified:gte", "description": "Task modification date. Search for results where this parameter value is greater than or equal to the specified value.", "schema": { "type": "string", "format": "date" } }, { "in": "query", "name": "modified:lt", "description": "Task modification date. Search for results where this parameter value is less than the specified value.", "schema": { "type": "string", "format": "date" } }, { "in": "query", "name": "modified:lte", "description": "Task modification date. Search for results where this parameter value is less than or equal to the specified value.", "schema": { "type": "string", "format": "date" } }, { "in": "query", "name": "contents:contains", "description": "Task content. Search for results that contain the specified characters in this parameter.", "schema": { "type": "string" } }, { "in": "query", "name": "status", "description": "Filter tasks by status. Accepted values: `D`, `P`, `C`.", "schema": { "type": "array", "items": { "type": "string" }, "enum": [ "D", "P", "C" ] } }, { "in": "query", "name": "deleted", "description": "Whether the task has been deleted", "schema": { "type": "boolean" } }, { "in": "query", "name": "orderBy", "description": "Sorting options", "schema": { "type": "array", "items": { "type": "string" }, "enum": [ "id:asc", "id:desc", "due:asc", "due:desc", "created:asc", "created:desc", "modified:asc", "modified:desc" ] } }, { "in": "query", "name": "offset", "description": "Offset", "schema": { "type": "integer" } }, { "in": "query", "name": "limit", "description": "Limit", "schema": { "type": "integer" } }, { "in": "query", "name": "with", "description": "With parameters", "schema": { "type": "string" } }, { "in": "query", "name": "mode", "description": "Determines the detail level of the response body.", "schema": { "type": "string", "enum": [ "full_with_links", "full", "compact" ] } } ], "x-codeSamples": [ { "lang": "Shell", "label": "cURL", "source": "curl -X GET \\\n \"https://{instance}.kiteworks.com/rest/folders/:id/tasks\" \\\n -H \"Authorization: Bearer YOUR_TOKEN\"" }, { "lang": "Python", "label": "Python", "source": "import requests\n\nid = \"VALUE\" # The unique identifier (UUID) of the folder.\n\nurl = f\"https://{{instance}}.kiteworks.com/rest/folders/{id}/tasks\"\nheaders = {\n \"Authorization\": \"Bearer YOUR_TOKEN\",\n}\nresponse = requests.get(url, headers=headers)\nprint(response.json())" } ] } }, "/rest/folders/{id}/tree": { "get": { "tags": [ "folders" ], "summary": "Get the ancestor path of a folder", "description": "Returns the ancestor path of the specified folder as an ordered list of folder nodes, from the root down to the target folder.", "responses": { "200": { "description": "Returns an ordered list of ancestor folder nodes from root to the specified folder, representing its full tree path.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/FolderTreeItem" } }, "metadata": { "$ref": "#/components/schemas/MetaData" } } }, "examples": { "FolderTree": { "summary": "Three-level ancestor chain", "value": [ { "id": "root1234567890abcd", "name": "My Files" }, { "id": "xyz98765cba43210fe", "name": "Projects" }, { "id": "abc12345def67890ab", "name": "Reports" } ] } } } } }, "403": { "description": "Forbidden

Possible error codes: ERR_ACCESS_DLI_ADMIN", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Errors" }, "examples": { "ERR_ACCESS_DLI_ADMIN": { "summary": "Authenticated user is not a DLI Admin", "description": "Authenticated user is not a DLI Admin", "value": { "errors": { "code": "ERR_ACCESS_DLI_ADMIN", "message": "Authenticated user is not a DLI Admin" } } } } } } }, "490": { "description": "Request blocked by WAF" } }, "deprecated": false, "parameters": [ { "in": "path", "name": "id", "description": "The unique identifier (UUID) of the folder.", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "includeOwner", "description": "Include owner root folder in the tree", "schema": { "type": "boolean" } }, { "in": "query", "name": "mode", "description": "Determines the detail level of the response body.", "schema": { "type": "string", "enum": [ "full_with_links", "full" ] } } ], "x-codeSamples": [ { "lang": "Shell", "label": "cURL", "source": "curl -X GET \\\n \"https://{instance}.kiteworks.com/rest/folders/:id/tree\" \\\n -H \"Authorization: Bearer YOUR_TOKEN\"" }, { "lang": "Python", "label": "Python", "source": "import requests\n\nid = \"VALUE\" # The unique identifier (UUID) of the folder.\n\nurl = f\"https://{{instance}}.kiteworks.com/rest/folders/{id}/tree\"\nheaders = {\n \"Authorization\": \"Bearer YOUR_TOKEN\",\n}\nresponse = requests.get(url, headers=headers)\nprint(response.json())" } ] } }, "/rest/folders/{parent}/files": { "get": { "summary": "Return the list of files in a folder", "description": "### Description:\n Returns the list of files within the specified folder.\n### Precondition:\n User must have `properties_view` permission for the folder.\n### Response:\n Returns a list of files within the specified folder.\n### Sorting:\n Sort string syntax `FIELD_NAME:ORDER`.\n\n ORDER can be `asc` or `desc`.\n### Sorting options:\n | FIELD_NAME | Description |\n |------------|-------------|\n | name | The name of the file |\n | created | The creation datetime of file |\n | modified | The last modified datetime of file |\n | size | The file size (for files) |\n", "tags": [ "folders" ], "parameters": [ { "in": "path", "name": "parent", "required": true, "description": "The unique identifier (UUID) of the parent folder.", "schema": { "type": "string", "format": "uuid" } }, { "in": "query", "name": "deleted", "required": false, "description": "Filter by deletion status. If true, show only deleted items; if false, show non-deleted items; if not specified, show both deleted and non-deleted items.", "schema": { "type": "boolean" } }, { "in": "query", "name": "name", "required": false, "description": "Filter by the name of file within the folder.", "schema": { "type": "string" } }, { "in": "query", "name": "name:contains", "required": false, "description": "Search for files whose names contain the specified characters.", "schema": { "type": "string" } }, { "in": "query", "name": "userId", "required": false, "description": "The unique identifier of the file creator.", "schema": { "type": "string" } }, { "in": "query", "name": "userId:in", "required": false, "explode": true, "style": "form", "description": "Search for files created by the specified user IDs. (Recommended request size <= 100)", "schema": { "type": "array", "items": { "type": "string" } } }, { "in": "query", "name": "created", "required": false, "description": "Search for files created on the specified date.", "schema": { "type": "string", "format": "date" } }, { "in": "query", "name": "created:gt", "required": false, "description": "Search for files created after the specified date.", "schema": { "type": "string", "format": "date" } }, { "in": "query", "name": "created:gte", "required": false, "description": "Search for files created on or after the specified date.", "schema": { "type": "string", "format": "date" } }, { "in": "query", "name": "created:lt", "required": false, "description": "Search for files created before the specified date.", "schema": { "type": "string", "format": "date" } }, { "in": "query", "name": "created:lte", "required": false, "description": "Search for files created on or before the specified date.", "schema": { "type": "string", "format": "date" } }, { "in": "query", "name": "modified", "required": false, "description": "Search for files modified on the specified date.", "schema": { "type": "string", "format": "date" } }, { "in": "query", "name": "modified:gt", "required": false, "description": "Search for files modified after the specified date.", "schema": { "type": "string", "format": "date" } }, { "in": "query", "name": "modified:gte", "required": false, "description": "Search for files modified on or after the specified date.", "schema": { "type": "string", "format": "date" } }, { "in": "query", "name": "modified:lt", "required": false, "description": "Search for files modified before the specified date.", "schema": { "type": "string", "format": "date" } }, { "in": "query", "name": "modified:lte", "required": false, "description": "Search for files modified on or before the specified date.", "schema": { "type": "string", "format": "date" } }, { "in": "query", "name": "expire", "required": false, "description": "Search for files that expire on the specified date.", "schema": { "type": "string", "format": "date" } }, { "in": "query", "name": "expire:gt", "required": false, "description": "Search for files that expire after the specified date.", "schema": { "type": "string", "format": "date" } }, { "in": "query", "name": "expire:gte", "required": false, "description": "Search for files that expire on or after the specified date.", "schema": { "type": "string", "format": "date" } }, { "in": "query", "name": "expire:lt", "required": false, "description": "Search for files that expire before the specified date.", "schema": { "type": "string", "format": "date" } }, { "in": "query", "name": "expire:lte", "required": false, "description": "Search for files that expire on or before the specified date.", "schema": { "type": "string", "format": "date" } }, { "in": "query", "name": "isPushed", "required": false, "description": "If true, returns only files that have been pushed to a mobile device via the mobile sync feature.", "schema": { "type": "boolean" } }, { "in": "query", "name": "orderBy", "required": false, "description": "Sort order for the results. Default is `name:asc`.
Allowed values: `name:asc`, `name:desc`, `created:asc`, `created:desc`, `modified:asc`, `modified:desc`, `size:asc`, `size:desc`.", "schema": { "type": "string", "enum": [ "name:asc", "name:desc", "created:asc", "created:desc", "modified:asc", "modified:desc", "size:asc", "size:desc" ] } }, { "in": "query", "name": "limit", "required": false, "description": "Range limit.", "schema": { "type": "integer", "minimum": 1 } }, { "in": "query", "name": "offset", "required": false, "description": "Range offset.", "schema": { "type": "integer", "minimum": 0 } }, { "in": "query", "name": "with", "required": false, "description": "Specifies additional fields to include in the response.", "schema": { "type": "string" } }, { "in": "query", "name": "mode", "required": false, "description": "Determines the detail level of the response body.", "schema": { "type": "string", "enum": [ "compact", "full_no_links", "full_with_links", "full" ] } } ], "responses": { "200": { "description": "A list of files in the folder is returned successfully.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FolderChildrenFiles" } } } }, "400": { "description": "Bad Request

Possible error codes: ERR_REQUEST_INVALID_JSON", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Errors" }, "examples": { "ERR_REQUEST_INVALID_JSON": { "summary": "Invalid json provided", "description": "Invalid json provided", "value": { "errors": [ { "code": "ERR_REQUEST_INVALID_JSON", "message": "Invalid json provided" } ] } } } } } }, "401": { "description": "Unauthorized

Possible error codes: ERR_ACCESS_USER, ERR_AUTH_INVALID_CSRF, ERR_AUTH_UNAUTHORIZED", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Errors" }, "examples": { "ERR_ACCESS_USER": { "summary": "Insufficient access permissions", "description": "Insufficient access permissions", "value": { "errors": [ { "code": "ERR_ACCESS_USER", "message": "Insufficient access permissions" } ] } }, "ERR_AUTH_INVALID_CSRF": { "summary": "Invalid CSRF Authentication", "description": "Invalid CSRF Authentication", "value": { "errors": [ { "code": "ERR_AUTH_INVALID_CSRF", "message": "Invalid CSRF Authentication" } ] } }, "ERR_AUTH_UNAUTHORIZED": { "summary": "Unauthorized", "description": "Unauthorized", "value": { "errors": [ { "code": "ERR_AUTH_UNAUTHORIZED", "message": "Unauthorized" } ] } } } } } }, "422": { "description": "Unprocessable Content

Possible error codes: ERR_INVALID_PARAMETER", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Errors" }, "examples": { "ERR_INVALID_PARAMETER": { "summary": "Invalid Parameter Exception", "description": "Invalid Parameter Exception", "value": { "errors": [ { "code": "ERR_INVALID_PARAMETER", "message": "Invalid Parameter Exception" } ] } } } } } }, "490": { "description": "Request blocked by WAF" } }, "x-codeSamples": [ { "lang": "Shell", "label": "cURL", "source": "curl -X GET \\\n \"https://{instance}.kiteworks.com/rest/folders/:parent/files\" \\\n -H \"Authorization: Bearer YOUR_TOKEN\"" }, { "lang": "Python", "label": "Python", "source": "import requests\n\nparent = \"VALUE\" # The unique identifier (UUID) of the parent folder.\n\nurl = f\"https://{{instance}}.kiteworks.com/rest/folders/{parent}/files\"\nheaders = {\n \"Authorization\": \"Bearer YOUR_TOKEN\",\n}\nresponse = requests.get(url, headers=headers)\nprint(response.json())" } ] } }, "/rest/permissions/folder/{id}": { "get": { "summary": "List folder permissions", "description": "### Description:\n Return the list of permissions associated with the specified folder.\n### Precondition:\n The user must be a member of the folder.\n### Response:\n Returns a list of available permissions for the specified folder.\n", "tags": [ "folders" ], "parameters": [ { "in": "path", "name": "id", "required": true, "description": "The unique identifier (UUID) of the entity.", "schema": { "type": "string", "format": "uuid" } }, { "in": "query", "name": "actionId", "required": false, "description": "The unique identifier for the action.", "schema": { "type": "integer", "minimum": 1 } }, { "in": "query", "name": "id:in", "required": false, "explode": true, "style": "form", "description": "List of unique action identifiers. Search for results that match any of the specified values.", "schema": { "type": "array", "items": { "type": "integer" } } }, { "in": "query", "name": "name", "required": false, "description": "Filter by the permission action name.
Allowed values: `view`, `download`, `comment_view`, `comment_add`, `comment_edit`, `comment_reply`, `comment_delete`, `task_view`, `task_update_status`, `notification_subscribe`, `notification_unsubscribe`, `properties_view`, `file_send`, `tray_add`, `favorite_add`.", "schema": { "type": "string", "enum": [ "view", "download", "comment_view", "comment_add", "comment_edit", "comment_reply", "comment_delete", "task_view", "task_update_status", "notification_subscribe", "notification_unsubscribe", "properties_view", "file_send", "tray_add", "favorite_add", "file_copy", "mobile_sync", "file_preview_send", "folder_copy", "message_send", "task_add", "task_edit", "task_delete", "user_view", "children_view_deleted", "folder_add", "file_add", "folder_delete", "lock", "unlock", "file_recover", "version_view", "version_create", "version_promote", "version_delete", "file_delete", "file_edit", "properties_edit", "user_add", "user_edit", "user_remove", "rename", "folder_recover", "folder_permanent_delete", "sync_enable", "sync_disable", "file_permanent_delete", "user_add_external", "user_edit_external", "user_remove_external", "mobile_sync_push", "mobile_sync_unpush", "folder_move", "file_move", "top_shared_folder_delete" ] } }, { "in": "query", "name": "name:contains", "required": false, "description": "Action name filter. Search for actions whose names contain the specified characters.", "schema": { "type": "string" } }, { "in": "query", "name": "with", "required": false, "description": "Specifies additional fields to include in the response.", "schema": { "type": "string" } }, { "in": "query", "name": "mode", "required": false, "description": "Determines the detail level of the response body.", "schema": { "type": "string", "enum": [ "compact", "full_no_links", "full_with_links", "full" ] } } ], "responses": { "200": { "description": "Successfully returned the list of permissions for the specified folder.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FolderPermissions" } } } }, "400": { "description": "Bad Request

Possible error codes: ERR_REQUEST_INVALID_JSON", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Errors" }, "examples": { "ERR_REQUEST_INVALID_JSON": { "summary": "Invalid json provided", "description": "Invalid json provided", "value": { "errors": [ { "code": "ERR_REQUEST_INVALID_JSON", "message": "Invalid json provided" } ] } } } } } }, "401": { "description": "Unauthorized

Possible error codes: ERR_ACCESS_USER, ERR_AUTH_INVALID_CSRF, ERR_AUTH_UNAUTHORIZED", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Errors" }, "examples": { "ERR_ACCESS_USER": { "summary": "Insufficient access permissions", "description": "Insufficient access permissions", "value": { "errors": [ { "code": "ERR_ACCESS_USER", "message": "Insufficient access permissions" } ] } }, "ERR_AUTH_INVALID_CSRF": { "summary": "Invalid CSRF Authentication", "description": "Invalid CSRF Authentication", "value": { "errors": [ { "code": "ERR_AUTH_INVALID_CSRF", "message": "Invalid CSRF Authentication" } ] } }, "ERR_AUTH_UNAUTHORIZED": { "summary": "Unauthorized", "description": "Unauthorized", "value": { "errors": [ { "code": "ERR_AUTH_UNAUTHORIZED", "message": "Unauthorized" } ] } } } } } }, "422": { "description": "Unprocessable Content

Possible error codes: ERR_INVALID_PARAMETER", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Errors" }, "examples": { "ERR_INVALID_PARAMETER": { "summary": "Invalid Parameter Exception", "description": "Invalid Parameter Exception", "value": { "errors": [ { "code": "ERR_INVALID_PARAMETER", "message": "Invalid Parameter Exception" } ] } } } } } }, "490": { "description": "Request blocked by WAF" } }, "x-codeSamples": [ { "lang": "Shell", "label": "cURL", "source": "curl -X GET \\\n \"https://{instance}.kiteworks.com/rest/permissions/folder/:id\" \\\n -H \"Authorization: Bearer YOUR_TOKEN\"" }, { "lang": "Python", "label": "Python", "source": "import requests\n\nid = \"VALUE\" # The unique identifier (UUID) of the entity.\n\nurl = f\"https://{{instance}}.kiteworks.com/rest/permissions/folder/{id}\"\nheaders = {\n \"Authorization\": \"Bearer YOUR_TOKEN\",\n}\nresponse = requests.get(url, headers=headers)\nprint(response.json())" } ] } }, "/rest/folders/actions/move": { "post": { "summary": "Move multiple folders", "description": "### Description:\n Moves multiple folders to a new destination folder.\n### Precondition:\n User must have `folder_move` permission for the folders being moved.\n User must have `folder_add` permission for the destination folder.\n### Response:\n The folders are moved to the destination folder.\n", "tags": [ "folders" ], "parameters": [ { "in": "query", "name": "returnEntity", "required": false, "description": "If true, includes the entity in the response body.", "schema": { "type": "boolean" } }, { "in": "query", "name": "with", "required": false, "description": "Specifies additional fields to include in the response.", "schema": { "type": "string" } }, { "in": "query", "name": "mode", "required": false, "description": "Determines the detail level of the response body.", "schema": { "type": "string", "enum": [ "compact", "full_no_links", "full_with_links", "full" ] } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MultipleFolderIdRequest" } } } }, "responses": { "201": { "description": "Folders successfully moved.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BulkOperationMoveFolders" } } } }, "207": { "description": "Partially successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BulkOperationMoveFolders" } } } }, "403": { "description": "Forbidden

Possible error codes: ERR_SYSTEM_FOLDER_QUOTA_EXCEEDED", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Errors" }, "examples": { "ERR_SYSTEM_FOLDER_QUOTA_EXCEEDED": { "summary": "Folder's remaining storage quota does not permit for a file upload or operation of this size.", "description": "Folder's remaining storage quota does not permit for a file upload or operation of this size.", "value": { "errors": [ { "code": "ERR_SYSTEM_FOLDER_QUOTA_EXCEEDED", "message": "Folder's remaining storage quota does not permit for a file upload or operation of this size." } ] } } } } } }, "490": { "description": "Request blocked by WAF" } }, "x-codeSamples": [ { "lang": "Shell", "label": "cURL", "source": "curl -X POST \\\n \"https://{instance}.kiteworks.com/rest/folders/actions/move\" \\\n -H \"Authorization: Bearer YOUR_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"folderIds\": [\n \"string\"\n ],\n \"destinationFolderId\": \"string\"\n }'" }, { "lang": "Python", "label": "Python", "source": "import requests\n\nurl = \"https://{instance}.kiteworks.com/rest/folders/actions/move\"\nheaders = {\n \"Authorization\": \"Bearer YOUR_TOKEN\",\n \"Content-Type\": \"application/json\",\n}\npayload = {\n \"folderIds\": [\n \"string\"\n],\n \"destinationFolderId\": \"string\"\n}\nresponse = requests.post(url, headers=headers, json=payload)\nprint(response.json())" } ] } }, "/rest/folders/{id}/quota": { "get": { "summary": "Return the folder quota", "description": "### Description:\n Returns the quota information for a specific folder.\n### Precondition:\n User must have `file_add` permission for the folder.\n### Response:\n The folder quota is returned.\n", "tags": [ "folders" ], "parameters": [ { "in": "path", "name": "id", "required": true, "description": "The unique identifier (UUID) of the entity.", "schema": { "type": "string", "format": "uuid" } }, { "in": "query", "name": "fileId", "required": false, "description": "The unique identifier (UUID) of the file.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "The folder quota has been successfully returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FolderQuota" } } } }, "401": { "description": "Unauthorized

Possible error codes: ERR_ACCESS_USER, ERR_AUTH_INVALID_CSRF, ERR_AUTH_UNAUTHORIZED, ERR_ENTITY_NOT_FOUND", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Errors" }, "examples": { "ERR_ACCESS_USER": { "summary": "Insufficient access permissions", "description": "Insufficient access permissions", "value": { "errors": [ { "code": "ERR_ACCESS_USER", "message": "Insufficient access permissions" } ] } }, "ERR_AUTH_INVALID_CSRF": { "summary": "Invalid CSRF Authentication", "description": "Invalid CSRF Authentication", "value": { "errors": [ { "code": "ERR_AUTH_INVALID_CSRF", "message": "Invalid CSRF Authentication" } ] } }, "ERR_AUTH_UNAUTHORIZED": { "summary": "Unauthorized", "description": "Unauthorized", "value": { "errors": [ { "code": "ERR_AUTH_UNAUTHORIZED", "message": "Unauthorized" } ] } }, "ERR_ENTITY_NOT_FOUND": { "summary": "Entity does not exist", "description": "Entity does not exist", "value": { "errors": [ { "code": "ERR_ENTITY_NOT_FOUND", "message": "Entity does not exist" } ] } } } } } }, "403": { "description": "Forbidden

Possible error codes: ERR_ENTITY_DELETED", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Errors" }, "examples": { "ERR_ENTITY_DELETED": { "summary": "Entity is deleted", "description": "Entity is deleted", "value": { "errors": [ { "code": "ERR_ENTITY_DELETED", "message": "Entity is deleted" } ] } } } } } }, "490": { "description": "Request blocked by WAF" } }, "x-codeSamples": [ { "lang": "Shell", "label": "cURL", "source": "curl -X GET \\\n \"https://{instance}.kiteworks.com/rest/folders/:id/quota\" \\\n -H \"Authorization: Bearer YOUR_TOKEN\"" }, { "lang": "Python", "label": "Python", "source": "import requests\n\nid = \"VALUE\" # The unique identifier (UUID) of the entity.\n\nurl = f\"https://{{instance}}.kiteworks.com/rest/folders/{id}/quota\"\nheaders = {\n \"Authorization\": \"Bearer YOUR_TOKEN\",\n}\nresponse = requests.get(url, headers=headers)\nprint(response.json())" } ] } }, "/rest/folders/{id}/children": { "get": { "summary": "List folder children", "description": "### Description:\n Returns the list of folder children, where folders are fetched first, followed by files.\n### Precondition:\n User must have `properties_view` permission for the folder.\n### Response:\n Returns a list of folders and files within the specified folder.\n### Sorting:\n Sort string syntax `FIELD_NAME:ORDER`.\n\n ORDER can be `asc` or `desc`.\n### Sorting options:\n | FIELD_NAME | Description |\n |------------|-------------|\n | name | The name of the folder or file |\n | created | The creation datetime of the folder or file |\n | modified | The last modified datetime of the folder or file |\n | size | The number of items in the folder (for folders) or the file size (for files) |\n", "tags": [ "folders" ], "parameters": [ { "in": "path", "name": "id", "required": true, "description": "The unique identifier (UUID) of the entity.", "schema": { "type": "string", "format": "uuid" } }, { "in": "query", "name": "deleted", "required": false, "description": "Filter by deletion status. If true, show only deleted items; if false, show non-deleted items; if not specified, show both deleted and non-deleted items.", "schema": { "type": "boolean" } }, { "in": "query", "name": "orderBy", "required": false, "description": "Sort order for the results. Default is `name:asc`.
Allowed values: `name:asc`, `name:desc`, `created:asc`, `created:desc`, `modified:asc`, `modified:desc`, `size:asc`, `size:desc`.", "schema": { "type": "string", "enum": [ "name:asc", "name:desc", "created:asc", "created:desc", "modified:asc", "modified:desc", "size:asc", "size:desc" ] } }, { "in": "query", "name": "type", "required": false, "description": "Filter results by object type.
`f` – Files only.
`d` – Directories (folders) only.", "schema": { "type": "string", "enum": [ "f", "d" ] } }, { "in": "query", "name": "extensions", "required": false, "description": "A comma-delimited list of file extensions to include in the filter.", "schema": { "type": "string" } }, { "in": "query", "name": "regex", "required": false, "description": "A regular expression pattern used to filter files by their names or other attributes.", "schema": { "type": "string" } }, { "in": "query", "name": "name", "required": false, "description": "Filter by the name of the folder or file within the folder.", "schema": { "type": "string" } }, { "in": "query", "name": "fileId", "required": false, "description": "Filter by a specific file ID.", "schema": { "type": "string" } }, { "in": "query", "name": "limit", "required": false, "description": "Range limit.", "schema": { "type": "integer", "minimum": 1 } }, { "in": "query", "name": "offset", "required": false, "description": "Range offset.", "schema": { "type": "integer", "minimum": 0 } }, { "in": "query", "name": "with", "required": false, "description": "Specifies additional fields to include in the response.", "schema": { "type": "string" } }, { "in": "query", "name": "mode", "required": false, "description": "Determines the detail level of the response body.", "schema": { "type": "string", "enum": [ "compact", "full_no_links", "full_with_links", "full" ] } } ], "responses": { "200": { "description": "Returns the list of folder children.\n", "content": { "application/json": { "schema": { "type": "array", "items": { "oneOf": [ { "$ref": "#/components/schemas/Folder" }, { "$ref": "#/components/schemas/File" } ], "discriminator": { "propertyName": "type" } } } } } }, "400": { "description": "Bad Request

Possible error codes: ERR_REQUEST_INVALID_JSON", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Errors" }, "examples": { "ERR_REQUEST_INVALID_JSON": { "summary": "Invalid json provided", "description": "Invalid json provided", "value": { "errors": [ { "code": "ERR_REQUEST_INVALID_JSON", "message": "Invalid json provided" } ] } } } } } }, "401": { "description": "Unauthorized

Possible error codes: ERR_ACCESS_USER, ERR_AUTH_INVALID_CSRF, ERR_AUTH_UNAUTHORIZED", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Errors" }, "examples": { "ERR_ACCESS_USER": { "summary": "Insufficient access permissions", "description": "Insufficient access permissions", "value": { "errors": [ { "code": "ERR_ACCESS_USER", "message": "Insufficient access permissions" } ] } }, "ERR_AUTH_INVALID_CSRF": { "summary": "Invalid CSRF Authentication", "description": "Invalid CSRF Authentication", "value": { "errors": [ { "code": "ERR_AUTH_INVALID_CSRF", "message": "Invalid CSRF Authentication" } ] } }, "ERR_AUTH_UNAUTHORIZED": { "summary": "Unauthorized", "description": "Unauthorized", "value": { "errors": [ { "code": "ERR_AUTH_UNAUTHORIZED", "message": "Unauthorized" } ] } } } } } }, "422": { "description": "Unprocessable Content

Possible error codes: ERR_INVALID_PARAMETER", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Errors" }, "examples": { "ERR_INVALID_PARAMETER": { "summary": "Invalid Parameter Exception", "description": "Invalid Parameter Exception", "value": { "errors": [ { "code": "ERR_INVALID_PARAMETER", "message": "Invalid Parameter Exception" } ] } } } } } }, "490": { "description": "Request blocked by WAF" } }, "x-codeSamples": [ { "lang": "Shell", "label": "cURL", "source": "curl -X GET \\\n \"https://{instance}.kiteworks.com/rest/folders/:id/children\" \\\n -H \"Authorization: Bearer YOUR_TOKEN\"" }, { "lang": "Python", "label": "Python", "source": "import requests\n\nid = \"VALUE\" # The unique identifier (UUID) of the entity.\n\nurl = f\"https://{{instance}}.kiteworks.com/rest/folders/{id}/children\"\nheaders = {\n \"Authorization\": \"Bearer YOUR_TOKEN\",\n}\nresponse = requests.get(url, headers=headers)\nprint(response.json())" } ] } }, "/rest/folders/top": { "get": { "summary": "List top level folders", "description": "### Description:\n Returns the list of top level folders.\n### Precondition:\n The user profile must have \"Collaboration Allowed\" enabled.\n### Response:\n Lists of top level folders are returned.\n### Sorting:\n Sort string syntax `FIELD_NAME:ORDER`.\n\n ORDER can be `asc` or `desc`.\n### Sorting options:\n | FIELD_NAME | Description |\n |------------|-------------|\n | name | The name of the folder |\n | created | The creation datetime of the folder |\n | modified | The last modified datetime of the folder |\n | size | The number of items in the folder |\n", "tags": [ "folders" ], "parameters": [ { "in": "query", "name": "deleted", "required": false, "description": "Filter by deletion status. If true, show only deleted items; if false, show non-deleted items; if not specified, show both deleted and non-deleted items.", "schema": { "type": "boolean" } }, { "in": "query", "name": "orderBy", "required": false, "description": "Sort order for the results. Default is `name:asc`.
Allowed values: `name:asc`, `name:desc`, `created:asc`, `created:desc`, `modified:asc`, `modified:desc`, `size:asc`, `size:desc`.", "schema": { "type": "string", "enum": [ "name:asc", "name:desc", "created:asc", "created:desc", "modified:asc", "modified:desc", "size:asc", "size:desc" ] } }, { "in": "query", "name": "limit", "required": false, "description": "Range limit.", "schema": { "type": "integer", "minimum": 1 } }, { "in": "query", "name": "offset", "required": false, "description": "Range offset.", "schema": { "type": "integer", "minimum": 0 } }, { "in": "query", "name": "with", "required": false, "description": "Specifies additional fields to include in the response.", "schema": { "type": "string" } }, { "in": "query", "name": "mode", "required": false, "description": "Determines the detail level of the response body.", "schema": { "type": "string", "enum": [ "compact", "full_no_links", "full_with_links", "full" ] } } ], "responses": { "200": { "description": "The top level folders have been successfully returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Folders" } } } }, "400": { "description": "Bad Request

Possible error codes: ERR_REQUEST_INVALID_JSON", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Errors" }, "examples": { "ERR_REQUEST_INVALID_JSON": { "summary": "Invalid json provided", "description": "Invalid json provided", "value": { "errors": [ { "code": "ERR_REQUEST_INVALID_JSON", "message": "Invalid json provided" } ] } } } } } }, "401": { "description": "Unauthorized

Possible error codes: ERR_ACCESS_USER, ERR_AUTH_INVALID_CSRF, ERR_AUTH_UNAUTHORIZED", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Errors" }, "examples": { "ERR_ACCESS_USER": { "summary": "Insufficient access permissions", "description": "Insufficient access permissions", "value": { "errors": [ { "code": "ERR_ACCESS_USER", "message": "Insufficient access permissions" } ] } }, "ERR_AUTH_INVALID_CSRF": { "summary": "Invalid CSRF Authentication", "description": "Invalid CSRF Authentication", "value": { "errors": [ { "code": "ERR_AUTH_INVALID_CSRF", "message": "Invalid CSRF Authentication" } ] } }, "ERR_AUTH_UNAUTHORIZED": { "summary": "Unauthorized", "description": "Unauthorized", "value": { "errors": [ { "code": "ERR_AUTH_UNAUTHORIZED", "message": "Unauthorized" } ] } } } } } }, "422": { "description": "Unprocessable Content

Possible error codes: ERR_INVALID_PARAMETER", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Errors" }, "examples": { "ERR_INVALID_PARAMETER": { "summary": "Invalid Parameter Exception", "description": "Invalid Parameter Exception", "value": { "errors": [ { "code": "ERR_INVALID_PARAMETER", "message": "Invalid Parameter Exception" } ] } } } } } }, "490": { "description": "Request blocked by WAF" } }, "x-codeSamples": [ { "lang": "Shell", "label": "cURL", "source": "curl -X GET \\\n \"https://{instance}.kiteworks.com/rest/folders/top\" \\\n -H \"Authorization: Bearer YOUR_TOKEN\"" }, { "lang": "Python", "label": "Python", "source": "import requests\n\nurl = \"https://{instance}.kiteworks.com/rest/folders/top\"\nheaders = {\n \"Authorization\": \"Bearer YOUR_TOKEN\",\n}\nresponse = requests.get(url, headers=headers)\nprint(response.json())" } ] } }, "/rest/folders/{id}": { "get": { "summary": "Return the folder", "description": "### Description:\n Returns the folder corresponding to the provided ID.\n### Precondition:\n User must have `properties_view` permission for the folder.\n### Response:\n The folder is returned.\n", "tags": [ "folders" ], "parameters": [ { "in": "path", "name": "id", "required": true, "description": "The unique identifier (UUID) of the entity.", "schema": { "type": "string", "format": "uuid" } }, { "in": "query", "name": "returnEntity", "required": false, "description": "If true, includes the entity in the response body.", "schema": { "type": "boolean" } }, { "in": "query", "name": "with", "required": false, "description": "Specifies additional fields to include in the response.", "schema": { "type": "string" } }, { "in": "query", "name": "mode", "required": false, "description": "Determines the detail level of the response body.", "schema": { "type": "string", "enum": [ "compact", "full_no_links", "full_with_links", "full" ] } } ], "responses": { "200": { "description": "The folder has been successfully returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Folder1" } } } }, "400": { "description": "Bad Request

Possible error codes: ERR_REQUEST_INVALID_FILTER", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Errors" }, "examples": { "ERR_REQUEST_INVALID_FILTER": { "summary": "Filter validation failed", "description": "Filter validation failed", "value": { "errors": [ { "code": "ERR_REQUEST_INVALID_FILTER", "message": "Filter validation failed" } ] } } } } } }, "401": { "description": "Unauthorized

Possible error codes: ERR_AUTH_INVALID_CSRF, ERR_AUTH_UNAUTHORIZED", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Errors" }, "examples": { "ERR_AUTH_INVALID_CSRF": { "summary": "Invalid CSRF Authentication", "description": "Invalid CSRF Authentication", "value": { "errors": [ { "code": "ERR_AUTH_INVALID_CSRF", "message": "Invalid CSRF Authentication" } ] } }, "ERR_AUTH_UNAUTHORIZED": { "summary": "Unauthorized", "description": "Unauthorized", "value": { "errors": [ { "code": "ERR_AUTH_UNAUTHORIZED", "message": "Unauthorized" } ] } } } } } }, "403": { "description": "Forbidden

Possible error codes: ERR_ACCESS_USER, ERR_ACCESS_DENIED", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Errors" }, "examples": { "ERR_ACCESS_USER": { "summary": "Insufficient access permissions", "description": "Insufficient access permissions", "value": { "errors": [ { "code": "ERR_ACCESS_USER", "message": "Insufficient access permissions" } ] } }, "ERR_ACCESS_DENIED": { "summary": "Your access is denied.", "description": "Your access is denied.", "value": { "errors": [ { "code": "ERR_ACCESS_DENIED", "message": "Your access is denied.", "redirectUrl": "/login?code=3317" } ] } } } } } }, "490": { "description": "Request blocked by WAF" } }, "x-codeSamples": [ { "lang": "Shell", "label": "cURL", "source": "curl -X GET \\\n \"https://{instance}.kiteworks.com/rest/folders/:id\" \\\n -H \"Authorization: Bearer YOUR_TOKEN\"" }, { "lang": "Python", "label": "Python", "source": "import requests\n\nid = \"VALUE\" # The unique identifier (UUID) of the entity.\n\nurl = f\"https://{{instance}}.kiteworks.com/rest/folders/{id}\"\nheaders = {\n \"Authorization\": \"Bearer YOUR_TOKEN\",\n}\nresponse = requests.get(url, headers=headers)\nprint(response.json())" } ] }, "put": { "summary": "Update a folder", "description": "### Description:\n Updates the properties of the specified folder.\n### Precondition:\n User must have `properties_edit` permission for the folder.\n### Response:\n The folder is updated.\n", "tags": [ "folders" ], "parameters": [ { "in": "path", "name": "id", "required": true, "description": "The unique identifier (UUID) of the entity.", "schema": { "type": "string", "format": "uuid" } }, { "in": "query", "name": "returnEntity", "required": false, "description": "If true, includes the entity in the response body.", "schema": { "type": "boolean" } }, { "in": "query", "name": "with", "required": false, "description": "Specifies additional fields to include in the response.", "schema": { "type": "string" } }, { "in": "query", "name": "mode", "required": false, "description": "Determines the detail level of the response body.", "schema": { "type": "string", "enum": [ "compact", "full_no_links", "full_with_links", "full" ] } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FolderUpdatePutRequest" } } } }, "responses": { "200": { "description": "The folder has been updated successfully.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Folder1" } } } }, "401": { "description": "Unauthorized

Possible error codes: ERR_AUTH_INVALID_CSRF, ERR_AUTH_UNAUTHORIZED", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Errors" }, "examples": { "ERR_AUTH_INVALID_CSRF": { "summary": "Invalid CSRF Authentication", "description": "Invalid CSRF Authentication", "value": { "errors": [ { "code": "ERR_AUTH_INVALID_CSRF", "message": "Invalid CSRF Authentication" } ] } }, "ERR_AUTH_UNAUTHORIZED": { "summary": "Unauthorized", "description": "Unauthorized", "value": { "errors": [ { "code": "ERR_AUTH_UNAUTHORIZED", "message": "Unauthorized" } ] } } } } } }, "403": { "description": "Forbidden

Possible error codes: ERR_ACCESS_DENIED, ERR_ACCESS_USER", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Errors" }, "examples": { "ERR_ACCESS_DENIED": { "summary": "Your access is denied.", "description": "Your access is denied.", "value": { "errors": [ { "code": "ERR_ACCESS_DENIED", "message": "Your access is denied.", "redirectUrl": "/login?code=3317" } ] } }, "ERR_ACCESS_USER": { "summary": "Insufficient access permissions", "description": "Insufficient access permissions", "value": { "errors": [ { "code": "ERR_ACCESS_USER", "message": "Insufficient access permissions" } ] } } } } } }, "409": { "description": "Conflict

Possible error codes: ERR_ENTITY_EXISTS", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Errors" }, "examples": { "ERR_ENTITY_EXISTS": { "summary": "Entity exists", "description": "Entity exists", "value": { "errors": [ { "code": "ERR_ENTITY_EXISTS", "message": "Entity exists" } ] } } } } } }, "490": { "description": "Request blocked by WAF" } }, "x-codeSamples": [ { "lang": "Shell", "label": "cURL", "source": "curl -X PUT \\\n \"https://{instance}.kiteworks.com/rest/folders/:id\" \\\n -H \"Authorization: Bearer YOUR_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"name\": \"string\",\n \"description\": \"string\",\n \"syncable\": true,\n \"expire\": \"2024-01-15\",\n \"fileLifetime\": 1,\n \"applyFileLifetimeToFiles\": true\n }'" }, { "lang": "Python", "label": "Python", "source": "import requests\n\nid = \"VALUE\" # The unique identifier (UUID) of the entity.\n\nurl = f\"https://{{instance}}.kiteworks.com/rest/folders/{id}\"\nheaders = {\n \"Authorization\": \"Bearer YOUR_TOKEN\",\n \"Content-Type\": \"application/json\",\n}\npayload = {\n \"name\": \"string\",\n \"description\": \"string\",\n \"syncable\": true,\n \"expire\": \"2024-01-15\",\n \"fileLifetime\": 1,\n \"applyFileLifetimeToFiles\": true\n}\nresponse = requests.put(url, headers=headers, json=payload)\nprint(response.json())" } ] }, "delete": { "summary": "Delete a folder", "description": "### Description:\n Deletes a specified folder.\n### Precondition:\n User must have `folder_delete` permission for the folder.\n### Response:\n The folder is deleted\n## Additional Information:\n The folder will be automatically deleted after a set number of days as configured by the administrator.\n", "tags": [ "folders" ], "parameters": [ { "in": "path", "name": "id", "required": true, "description": "The unique identifier (UUID) of the entity.", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "204": { "description": "The folder has been successfully deleted." }, "401": { "description": "Unauthorized

Possible error codes: ERR_AUTH_INVALID_CSRF, ERR_AUTH_UNAUTHORIZED", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Errors" }, "examples": { "ERR_AUTH_INVALID_CSRF": { "summary": "Invalid CSRF Authentication", "description": "Invalid CSRF Authentication", "value": { "errors": [ { "code": "ERR_AUTH_INVALID_CSRF", "message": "Invalid CSRF Authentication" } ] } }, "ERR_AUTH_UNAUTHORIZED": { "summary": "Unauthorized", "description": "Unauthorized", "value": { "errors": [ { "code": "ERR_AUTH_UNAUTHORIZED", "message": "Unauthorized" } ] } } } } } }, "403": { "description": "Forbidden

Possible error codes: ERR_SYSTEM_TENANT_SUSPENDED, ERR_ACCESS_DENIED, ERR_ENTITY_IS_SYNC_DIR, ERR_ENTITY_IS_MY_DIR, ERR_ENTITY_IS_BASE_DIR, ERR_ENTITY_IS_NOT_UPDATABLE, ERR_ENTITY_IS_SECURE_FOLDER, ERR_ENTITY_CONTAINS_LOCKED_FILES, ERR_ACCESS_USER, ERR_PROFILE_COLLABORATION_DISABLED, ERR_ENTITY_DELETED", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Errors" }, "examples": { "ERR_SYSTEM_TENANT_SUSPENDED": { "summary": "Access to the service is restricted by the service provider. Contact your administrator for updates on restoring normal access.", "description": "Access to the service is restricted by the service provider. Contact your administrator for updates on restoring normal access.", "value": { "errors": [ { "code": "ERR_SYSTEM_TENANT_SUSPENDED", "message": "Access to the service is restricted by the service provider. Contact your administrator for updates on restoring normal access." } ] } }, "ERR_ACCESS_DENIED": { "summary": "Your access is denied.", "description": "Your access is denied.", "value": { "errors": [ { "code": "ERR_ACCESS_DENIED", "message": "Your access is denied.", "redirectUrl": "/login?code=3317" } ] } }, "ERR_ENTITY_IS_SYNC_DIR": { "summary": "Operation not permitted on My Folder", "description": "Operation not permitted on My Folder", "value": { "errors": [ { "code": "ERR_ENTITY_IS_SYNC_DIR", "message": "Operation not permitted on My Folder" } ] } }, "ERR_ENTITY_IS_MY_DIR": { "summary": "Operation not permitted on Tray Folder", "description": "Operation not permitted on Tray Folder", "value": { "errors": [ { "code": "ERR_ENTITY_IS_MY_DIR", "message": "Operation not permitted on Tray Folder" } ] } }, "ERR_ENTITY_IS_BASE_DIR": { "summary": "Operation not permitted on Base Folder", "description": "Operation not permitted on Base Folder", "value": { "errors": [ { "code": "ERR_ENTITY_IS_BASE_DIR", "message": "Operation not permitted on Base Folder" } ] } }, "ERR_ENTITY_IS_NOT_UPDATABLE": { "summary": "Can not update folder", "description": "Can not update folder", "value": { "errors": [ { "code": "ERR_ENTITY_IS_NOT_UPDATABLE", "message": "Can not update folder" } ] } }, "ERR_ENTITY_IS_SECURE_FOLDER": { "summary": "Operation not permitted on restricted Folder.", "description": "Operation not permitted on restricted Folder.", "value": { "errors": [ { "code": "ERR_ENTITY_IS_SECURE_FOLDER", "message": "Operation not permitted on restricted Folder." } ] } }, "ERR_ENTITY_CONTAINS_LOCKED_FILES": { "summary": "Folder contains locked files", "description": "Folder contains locked files", "value": { "errors": [ { "code": "ERR_ENTITY_CONTAINS_LOCKED_FILES", "message": "Folder contains locked files" } ] } }, "ERR_ACCESS_USER": { "summary": "Insufficient access permissions", "description": "Insufficient access permissions", "value": { "errors": [ { "code": "ERR_ACCESS_USER", "message": "Insufficient access permissions" } ] } }, "ERR_PROFILE_COLLABORATION_DISABLED": { "summary": "User's profile has no collaboration access", "description": "User's profile has no collaboration access", "value": { "errors": [ { "code": "ERR_PROFILE_COLLABORATION_DISABLED", "message": "User's profile has no collaboration access" } ] } }, "ERR_ENTITY_DELETED": { "summary": "Entity is deleted", "description": "Entity is deleted", "value": { "errors": [ { "code": "ERR_ENTITY_DELETED", "message": "Entity is deleted" } ] } } } } } }, "490": { "description": "Request blocked by WAF" } }, "x-codeSamples": [ { "lang": "Shell", "label": "cURL", "source": "curl -X DELETE \\\n \"https://{instance}.kiteworks.com/rest/folders/:id\" \\\n -H \"Authorization: Bearer YOUR_TOKEN\"" }, { "lang": "Python", "label": "Python", "source": "import requests\n\nid = \"VALUE\" # The unique identifier (UUID) of the entity.\n\nurl = f\"https://{{instance}}.kiteworks.com/rest/folders/{id}\"\nheaders = {\n \"Authorization\": \"Bearer YOUR_TOKEN\",\n}\nresponse = requests.delete(url, headers=headers)\nprint(response.json())" } ] } }, "/rest/folders/{id}/activities": { "get": { "summary": "Return folder activities", "description": "### Description:\nReturn the activities of a specified folder.\n\n### Precondition:\nThe user must have the `user_view` permission for the folder.\n\n### Response:\nReturns the folder activities.\n", "tags": [ "folders" ], "parameters": [ { "in": "path", "name": "id", "required": true, "description": "The unique identifier (UUID) of the entity.", "schema": { "type": "string", "format": "uuid" } }, { "in": "query", "name": "noDayBack", "required": false, "description": "Number of days to look back when searching for activities.", "schema": { "type": "integer" } }, { "in": "query", "name": "startTime", "required": false, "description": "Start time of the search range, represented as a Unix timestamp.", "schema": { "type": "integer" } }, { "in": "query", "name": "endTime", "required": false, "description": "End time of the search range, represented as a Unix timestamp.", "schema": { "type": "integer" } }, { "in": "query", "name": "startDate", "required": false, "description": "Start date of the search range.", "schema": { "type": "string", "format": "date" } }, { "in": "query", "name": "endDate", "required": false, "description": "End date of the search range.", "schema": { "type": "string", "format": "date" } }, { "in": "query", "name": "filter", "required": false, "description": "Filter activities by ownership.
`all` – Show all activities in the folder.
`my` – Show only activities performed by the current user.", "schema": { "type": "string", "enum": [ "all", "my" ] } }, { "in": "query", "name": "search", "required": false, "description": "Search activities by email body, subject, sender, or recipients.", "schema": { "type": "string" } }, { "in": "query", "name": "type", "required": false, "description": "Filter activities by type.
`all` – All activity types.
`content_changes` – File content uploads or replacements.
`file_changes` – File metadata changes (rename, move, delete, etc.).
`folder_changes` – Folder-level changes.
`kitepoint` – KitePoint reward activities.
`mail` – Email send/receive activities.
`tasks` – Task-related activities.
`comments` – Comment activities.
`folder_activities` – General folder activities.", "schema": { "type": "string", "enum": [ "all", "content_changes", "file_changes", "folder_changes", "kitepoint", "mail", "tasks", "comments", "folder_activities" ] } }, { "in": "query", "name": "transactionId", "required": false, "description": "Filter activities by transaction ID.", "schema": { "type": "string" } }, { "in": "query", "name": "orderBy", "required": false, "description": "Sort order for the results. Default is `created:desc`.
Allowed values: `id:asc`, `id:desc`, `created:asc`, `created:desc`, `event_name:asc`, `event_name:desc`, `name:asc`, `name:desc`.", "schema": { "type": "string", "enum": [ "id:asc", "id:desc", "created:asc", "created:desc", "event_name:asc", "event_name:desc", "name:asc", "name:desc" ] } }, { "in": "query", "name": "nested", "required": false, "description": "If set to `true`, includes activities from nested folders.", "schema": { "type": "boolean" } }, { "in": "query", "name": "fileId", "required": false, "description": "Specifies a file ID within the folder to filter activities related to that file.", "schema": { "type": "string" } }, { "in": "query", "name": "limit", "required": false, "description": "Range limit.", "schema": { "type": "integer", "minimum": 1 } }, { "in": "query", "name": "offset", "required": false, "description": "Range offset.", "schema": { "type": "integer", "minimum": 0 } }, { "in": "query", "name": "with", "required": false, "description": "Specifies additional fields to include in the response.", "schema": { "type": "string" } }, { "in": "query", "name": "mode", "required": false, "description": "Determines the detail level of the response body.", "schema": { "type": "string", "enum": [ "compact", "full_no_links", "full_with_links", "full" ] } } ], "responses": { "200": { "description": "Successfully return folder activities.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ActivityList" } } } }, "401": { "description": "Unauthorized

Possible error codes: ERR_ACCESS_USER, ERR_AUTH_INVALID_CSRF, ERR_AUTH_UNAUTHORIZED", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Errors" }, "examples": { "ERR_ACCESS_USER": { "summary": "Insufficient access permissions", "description": "Insufficient access permissions", "value": { "errors": [ { "code": "ERR_ACCESS_USER", "message": "Insufficient access permissions" } ] } }, "ERR_AUTH_INVALID_CSRF": { "summary": "Invalid CSRF Authentication", "description": "Invalid CSRF Authentication", "value": { "errors": [ { "code": "ERR_AUTH_INVALID_CSRF", "message": "Invalid CSRF Authentication" } ] } }, "ERR_AUTH_UNAUTHORIZED": { "summary": "Unauthorized", "description": "Unauthorized", "value": { "errors": [ { "code": "ERR_AUTH_UNAUTHORIZED", "message": "Unauthorized" } ] } } } } } }, "422": { "description": "Unprocessable Content

Possible error codes: ERR_INVALID_PARAMETER", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Errors" }, "examples": { "ERR_INVALID_PARAMETER": { "summary": "Invalid Parameter Exception", "description": "Invalid Parameter Exception", "value": { "errors": [ { "code": "ERR_INVALID_PARAMETER", "message": "Invalid Parameter Exception" } ] } } } } } }, "490": { "description": "Request blocked by WAF" } }, "x-codeSamples": [ { "lang": "Shell", "label": "cURL", "source": "curl -X GET \\\n \"https://{instance}.kiteworks.com/rest/folders/:id/activities\" \\\n -H \"Authorization: Bearer YOUR_TOKEN\"" }, { "lang": "Python", "label": "Python", "source": "import requests\n\nid = \"VALUE\" # The unique identifier (UUID) of the entity.\n\nurl = f\"https://{{instance}}.kiteworks.com/rest/folders/{id}/activities\"\nheaders = {\n \"Authorization\": \"Bearer YOUR_TOKEN\",\n}\nresponse = requests.get(url, headers=headers)\nprint(response.json())" } ] } }, "/rest/folders/{id}/activities/actions/exportCSV": { "get": { "summary": "Export folder activities", "description": "### Description:\nExports the activities of a folder in CSV format.\n\n### Precondition:\nThe user must have the `user_view` permission for the folder.\n\n### Response:\nThe folder activities are returned in CSV format.\n", "tags": [ "folders" ], "parameters": [ { "in": "path", "name": "id", "required": true, "description": "The unique identifier (UUID) of the entity.", "schema": { "type": "string", "format": "uuid" } }, { "in": "query", "name": "noDayBack", "required": false, "description": "Number of days to look back when searching for activities.", "schema": { "type": "integer" } }, { "in": "query", "name": "startTime", "required": false, "description": "Start time of the search range, represented as a Unix timestamp.", "schema": { "type": "integer" } }, { "in": "query", "name": "endTime", "required": false, "description": "End time of the search range, represented as a Unix timestamp.", "schema": { "type": "integer" } }, { "in": "query", "name": "startDate", "required": false, "description": "Start date of the search range.", "schema": { "type": "string", "format": "date" } }, { "in": "query", "name": "endDate", "required": false, "description": "End date of the search range.", "schema": { "type": "string", "format": "date" } }, { "in": "query", "name": "filter", "required": false, "description": "Filter activities by ownership.
`all` – Show all activities in the folder.
`my` – Show only activities performed by the current user.", "schema": { "type": "string", "enum": [ "all", "my" ] } }, { "in": "query", "name": "search", "required": false, "description": "Search activities by email body, subject, sender, or recipients.", "schema": { "type": "string" } }, { "in": "query", "name": "type", "required": false, "description": "Filter activities by type.
`all` – All activity types.
`content_changes` – File content uploads or replacements.
`file_changes` – File metadata changes (rename, move, delete, etc.).
`folder_changes` – Folder-level changes.
`kitepoint` – KitePoint reward activities.
`mail` – Email send/receive activities.
`tasks` – Task-related activities.
`comments` – Comment activities.
`folder_activities` – General folder activities.", "schema": { "type": "string", "enum": [ "all", "content_changes", "file_changes", "folder_changes", "kitepoint", "mail", "tasks", "comments", "folder_activities" ] } }, { "in": "query", "name": "transactionId", "required": false, "description": "Filter activities by transaction ID.", "schema": { "type": "string" } }, { "in": "query", "name": "orderBy", "required": false, "description": "Sort order for the results. Default is `created:desc`.
Allowed values: `id:asc`, `id:desc`, `created:asc`, `created:desc`, `event_name:asc`, `event_name:desc`, `name:asc`, `name:desc`.", "schema": { "type": "string", "enum": [ "id:asc", "id:desc", "created:asc", "created:desc", "event_name:asc", "event_name:desc", "name:asc", "name:desc" ] } }, { "in": "query", "name": "nested", "required": false, "description": "If set to `true`, includes activities from nested folders.", "schema": { "type": "boolean" } }, { "in": "query", "name": "fileId", "required": false, "description": "Specifies a file ID within the folder to filter activities related to that file.", "schema": { "type": "string" } }, { "in": "query", "name": "limit", "required": false, "description": "Range limit.", "schema": { "type": "integer", "minimum": 1 } }, { "in": "query", "name": "offset", "required": false, "description": "Range offset.", "schema": { "type": "integer", "minimum": 0 } }, { "in": "query", "name": "with", "required": false, "description": "Specifies additional fields to include in the response.", "schema": { "type": "string" } }, { "in": "query", "name": "mode", "required": false, "description": "Determines the detail level of the response body.", "schema": { "type": "string", "enum": [ "compact", "full_no_links", "full_with_links", "full" ] } } ], "responses": { "200": { "description": "Successfully initiated the folder activities export.", "content": { "text/csv": { "schema": { "type": "string", "format": "binary" } } } }, "401": { "description": "Unauthorized

Possible error codes: ERR_ACCESS_USER, ERR_AUTH_INVALID_CSRF, ERR_AUTH_UNAUTHORIZED", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Errors" }, "examples": { "ERR_ACCESS_USER": { "summary": "Insufficient access permissions", "description": "Insufficient access permissions", "value": { "errors": [ { "code": "ERR_ACCESS_USER", "message": "Insufficient access permissions" } ] } }, "ERR_AUTH_INVALID_CSRF": { "summary": "Invalid CSRF Authentication", "description": "Invalid CSRF Authentication", "value": { "errors": [ { "code": "ERR_AUTH_INVALID_CSRF", "message": "Invalid CSRF Authentication" } ] } }, "ERR_AUTH_UNAUTHORIZED": { "summary": "Unauthorized", "description": "Unauthorized", "value": { "errors": [ { "code": "ERR_AUTH_UNAUTHORIZED", "message": "Unauthorized" } ] } } } } } }, "422": { "description": "Unprocessable Content

Possible error codes: ERR_INVALID_PARAMETER", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Errors" }, "examples": { "ERR_INVALID_PARAMETER": { "summary": "Invalid Parameter Exception", "description": "Invalid Parameter Exception", "value": { "errors": [ { "code": "ERR_INVALID_PARAMETER", "message": "Invalid Parameter Exception" } ] } } } } } }, "490": { "description": "Request blocked by WAF" } }, "x-codeSamples": [ { "lang": "Shell", "label": "cURL", "source": "curl -X GET \\\n \"https://{instance}.kiteworks.com/rest/folders/:id/activities/actions/exportCSV\" \\\n -H \"Authorization: Bearer YOUR_TOKEN\"" }, { "lang": "Python", "label": "Python", "source": "import requests\n\nid = \"VALUE\" # The unique identifier (UUID) of the entity.\n\nurl = f\"https://{{instance}}.kiteworks.com/rest/folders/{id}/activities/actions/exportCSV\"\nheaders = {\n \"Authorization\": \"Bearer YOUR_TOKEN\",\n}\nresponse = requests.get(url, headers=headers)\nprint(response.json())" } ] } }, "/rest/folders/{id}/members/me": { "delete": { "summary": "Remove oneself as a folder member", "description": "### Description:\nRemoves the current user from the specified folder.\n\n### Precondition:\nThe user must be a member of the folder.\n\n### Response:\nThe current user is removed from the folder.\n", "tags": [ "folders" ], "parameters": [ { "in": "path", "name": "id", "required": true, "description": "The unique identifier (UUID) of the entity.", "schema": { "type": "string", "format": "uuid" } }, { "in": "query", "name": "downgradeNested", "required": false, "description": "If set to `true`, the user's role will be removed from all nested folders.", "schema": { "type": "boolean" } } ], "responses": { "204": { "description": "The user was successfully removed from the folder." }, "401": { "description": "Unauthorized

Possible error codes: ERR_AUTH_INVALID_CSRF, ERR_AUTH_UNAUTHORIZED", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Errors" }, "examples": { "ERR_AUTH_INVALID_CSRF": { "summary": "Invalid CSRF Authentication", "description": "Invalid CSRF Authentication", "value": { "errors": [ { "code": "ERR_AUTH_INVALID_CSRF", "message": "Invalid CSRF Authentication" } ] } }, "ERR_AUTH_UNAUTHORIZED": { "summary": "Unauthorized", "description": "Unauthorized", "value": { "errors": [ { "code": "ERR_AUTH_UNAUTHORIZED", "message": "Unauthorized" } ] } } } } } }, "403": { "description": "Forbidden

Possible error codes: ERR_ACCESS_USER, ERR_ENTITY_DELETED, ERR_INPUT_IS_OWNER, ERR_ENTITY_PARENT_FOLDER_MEMBER_EXISTS", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Errors" }, "examples": { "ERR_ACCESS_USER": { "summary": "Insufficient access permissions", "description": "Insufficient access permissions", "value": { "errors": [ { "code": "ERR_ACCESS_USER", "message": "Insufficient access permissions" } ] } }, "ERR_ENTITY_DELETED": { "summary": "Entity is deleted", "description": "Entity is deleted", "value": { "errors": [ { "code": "ERR_ENTITY_DELETED", "message": "Entity is deleted" } ] } }, "ERR_INPUT_IS_OWNER": { "summary": "Can not set owner role", "description": "Can not set owner role", "value": { "errors": [ { "code": "ERR_INPUT_IS_OWNER", "message": "Can not set owner role" } ] } }, "ERR_ENTITY_PARENT_FOLDER_MEMBER_EXISTS": { "summary": "Parent folder member exists", "description": "Parent folder member exists", "value": { "errors": [ { "code": "ERR_ENTITY_PARENT_FOLDER_MEMBER_EXISTS", "message": "Parent folder member exists" } ] } } } } } }, "422": { "description": "Unprocessable Content

Possible error codes: ERR_INVALID_PARAMETER", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Errors" }, "examples": { "ERR_INVALID_PARAMETER": { "summary": "Invalid Parameter Exception", "description": "Invalid Parameter Exception", "value": { "errors": [ { "code": "ERR_INVALID_PARAMETER", "message": "Invalid Parameter Exception" } ] } } } } } }, "490": { "description": "Request blocked by WAF" } }, "x-codeSamples": [ { "lang": "Shell", "label": "cURL", "source": "curl -X DELETE \\\n \"https://{instance}.kiteworks.com/rest/folders/:id/members/me\" \\\n -H \"Authorization: Bearer YOUR_TOKEN\"" }, { "lang": "Python", "label": "Python", "source": "import requests\n\nid = \"VALUE\" # The unique identifier (UUID) of the entity.\n\nurl = f\"https://{{instance}}.kiteworks.com/rest/folders/{id}/members/me\"\nheaders = {\n \"Authorization\": \"Bearer YOUR_TOKEN\",\n}\nresponse = requests.delete(url, headers=headers)\nprint(response.json())" } ] } }, "/rest/admin/folders": { "put": { "summary": "Bulk update folders", "description": "### Description:\n Updates multiple folders in a single request.\n### Precondition:\n The user must be an administrator with access to the Files and Folders page in the Kiteworks PDN Admin.\n### Response:\n The specified folders are updated.\n", "tags": [ "folders" ], "parameters": [ { "in": "query", "name": "returnEntity", "required": false, "description": "If true, includes the entity in the response body.", "schema": { "type": "boolean" } }, { "in": "query", "name": "with", "required": false, "description": "Specifies additional fields to include in the response.", "schema": { "type": "string" } }, { "in": "query", "name": "mode", "required": false, "description": "Determines the detail level of the response body.", "schema": { "type": "string", "enum": [ "compact", "full_no_links", "full_with_links", "full" ] } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AdminFolderPutRequest" } } } }, "responses": { "200": { "description": "Folders were updated successfully.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Folders" } } } }, "401": { "description": "Unauthorized

Possible error codes: ERR_AUTH_INVALID_CSRF, ERR_AUTH_UNAUTHORIZED", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Errors" }, "examples": { "ERR_AUTH_INVALID_CSRF": { "summary": "Invalid CSRF Authentication", "description": "Invalid CSRF Authentication", "value": { "errors": [ { "code": "ERR_AUTH_INVALID_CSRF", "message": "Invalid CSRF Authentication" } ] } }, "ERR_AUTH_UNAUTHORIZED": { "summary": "Unauthorized", "description": "Unauthorized", "value": { "errors": [ { "code": "ERR_AUTH_UNAUTHORIZED", "message": "Unauthorized" } ] } } } } } }, "403": { "description": "Forbidden

Possible error codes: ERR_ACCESS_USER, ERR_ENTITY_DELETED, ERR_ENTITY_DLP_LOCKED, ERR_ENTITY_IS_BASE_DIR, ERR_ENTITY_IS_MY_DIR, ERR_ENTITY_IS_SYNC_DIR, ERR_ENTITY_NOT_SCANNED, ERR_ENTITY_VIRUS_FOUND, ERR_PROFILE_COLLABORATION_DISABLED", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Errors" }, "examples": { "ERR_ACCESS_USER": { "summary": "Insufficient access permissions", "description": "Insufficient access permissions", "value": { "errors": [ { "code": "ERR_ACCESS_USER", "message": "Insufficient access permissions" } ] } }, "ERR_ENTITY_DELETED": { "summary": "Entity is deleted", "description": "Entity is deleted", "value": { "errors": [ { "code": "ERR_ENTITY_DELETED", "message": "Entity is deleted" } ] } }, "ERR_ENTITY_DLP_LOCKED": { "summary": "One or more files have been quarantined and are not available to download. Please contact your administrator for assistance.", "description": "One or more files have been quarantined and are not available to download. Please contact your administrator for assistance.", "value": { "errors": [ { "code": "ERR_ENTITY_DLP_LOCKED", "message": "One or more files have been quarantined and are not available to download. Please contact your administrator for assistance." } ] } }, "ERR_ENTITY_IS_BASE_DIR": { "summary": "Operation not permitted on Base Folder", "description": "Operation not permitted on Base Folder", "value": { "errors": [ { "code": "ERR_ENTITY_IS_BASE_DIR", "message": "Operation not permitted on Base Folder" } ] } }, "ERR_ENTITY_IS_MY_DIR": { "summary": "Operation not permitted on Tray Folder", "description": "Operation not permitted on Tray Folder", "value": { "errors": [ { "code": "ERR_ENTITY_IS_MY_DIR", "message": "Operation not permitted on Tray Folder" } ] } }, "ERR_ENTITY_IS_SYNC_DIR": { "summary": "Operation not permitted on My Folder", "description": "Operation not permitted on My Folder", "value": { "errors": [ { "code": "ERR_ENTITY_IS_SYNC_DIR", "message": "Operation not permitted on My Folder" } ] } }, "ERR_ENTITY_NOT_SCANNED": { "summary": "One or more files are undergoing security and privacy scans. Please try again later.", "description": "One or more files are undergoing security and privacy scans. Please try again later.", "value": { "errors": [ { "code": "ERR_ENTITY_NOT_SCANNED", "message": "One or more files are undergoing security and privacy scans. Please try again later." } ] } }, "ERR_ENTITY_VIRUS_FOUND": { "summary": "File is infected", "description": "File is infected", "value": { "errors": [ { "code": "ERR_ENTITY_VIRUS_FOUND", "message": "File is infected" } ] } }, "ERR_PROFILE_COLLABORATION_DISABLED": { "summary": "User's profile has no collaboration access", "description": "User's profile has no collaboration access", "value": { "errors": [ { "code": "ERR_PROFILE_COLLABORATION_DISABLED", "message": "User's profile has no collaboration access" } ] } } } } } }, "422": { "description": "Unprocessable Content

Possible error codes: ERR_INPUT_EXCEEDS_MAX_VALUE, ERR_INPUT_PAST_DATE, ERR_INVALID_PARAMETER, ERR_SYSTEM_EXTEND_FILE_EXPIRATION_DISABLED", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Errors" }, "examples": { "ERR_INPUT_EXCEEDS_MAX_VALUE": { "summary": "Field value exceeds maximum allowed value", "description": "Field value exceeds maximum allowed value", "value": { "errors": [ { "code": "ERR_INPUT_EXCEEDS_MAX_VALUE", "message": "Field value exceeds maximum allowed value" } ] } }, "ERR_INPUT_PAST_DATE": { "summary": "Field value should be future date", "description": "Field value should be future date", "value": { "errors": [ { "code": "ERR_INPUT_PAST_DATE", "message": "Field value should be future date" } ] } }, "ERR_INVALID_PARAMETER": { "summary": "Invalid Parameter Exception", "description": "Invalid Parameter Exception", "value": { "errors": [ { "code": "ERR_INVALID_PARAMETER", "message": "Invalid Parameter Exception" } ] } }, "ERR_SYSTEM_EXTEND_FILE_EXPIRATION_DISABLED": { "summary": "Extending file expiration is not allowed", "description": "Extending file expiration is not allowed", "value": { "errors": [ { "code": "ERR_SYSTEM_EXTEND_FILE_EXPIRATION_DISABLED", "message": "Extending file expiration is not allowed" } ] } } } } } }, "490": { "description": "Request blocked by WAF" } }, "x-codeSamples": [ { "lang": "Shell", "label": "cURL", "source": "curl -X PUT \\\n \"https://{instance}.kiteworks.com/rest/admin/folders\" \\\n -H \"Authorization: Bearer YOUR_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"ids\": [\n \"string\"\n ],\n \"expire\": \"2024-01-15\",\n \"applyTo\": \"folders_only\",\n \"quota\": 1,\n \"applyToNestedFiles\": true\n }'" }, { "lang": "Python", "label": "Python", "source": "import requests\n\nurl = \"https://{instance}.kiteworks.com/rest/admin/folders\"\nheaders = {\n \"Authorization\": \"Bearer YOUR_TOKEN\",\n \"Content-Type\": \"application/json\",\n}\npayload = {\n \"ids\": [\n \"string\"\n],\n \"expire\": \"2024-01-15\",\n \"applyTo\": \"folders_only\",\n \"quota\": 1,\n \"applyToNestedFiles\": true\n}\nresponse = requests.put(url, headers=headers, json=payload)\nprint(response.json())" } ] } } }, "components": { "schemas": { "Folder": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier (UUID) of the folder." }, "parentId": { "type": "string", "format": "uuid", "description": "Unique identifier (UUID) of the parent object." }, "name": { "type": "string", "description": "Name of the object." }, "type": { "type": "string", "description": "Type of the object.
`f` – File.
`d` – Folder." }, "userId": { "type": "string", "format": "uuid", "description": "Unique identifier (UUID) who created the folder." }, "creator": { "description": "Details of the user who created the object.", "allOf": [ { "$ref": "#/components/schemas/UserBasic" } ] }, "created": { "type": "string", "format": "date", "description": "The date and time when the object was created." }, "modified": { "type": "string", "format": "date", "description": "The date and time when the object was last modified." }, "expire": { "type": "string", "format": "date", "description": "Expiration timestamp of the object, if applicable." }, "permissions": { "description": "List of permissions associated with the object.", "type": "array", "items": { "$ref": "#/components/schemas/Permission" } }, "deleted": { "type": "boolean", "description": "Indicates whether the object has been deleted." }, "permDeleted": { "type": "boolean", "description": "Indicates whether the object has been permanently deleted." }, "permalink": { "type": "string", "description": "Permanent URL link to access the object." }, "path": { "type": "string", "description": "Path to the folder in the hierarchy." }, "members": { "description": "List of members who have access to the object.", "type": "array", "items": { "$ref": "#/components/schemas/Member" } }, "vendorDocId": { "type": "string", "description": "Vendor document ID associated with the object." }, "vendorDocName": { "type": "string", "description": "Name of the vendor document associated with the object." }, "secure": { "type": "boolean", "description": "Indicates whether the folder or the parent folder containing the file is marked as secure." }, "source": { "type": "integer", "description": "ID representing the source of the object (1 - Salesforce, 2 - Teams)." }, "isShared": { "type": "boolean", "description": "Indicates if the folder is shared with other users." }, "syncable": { "type": "boolean", "description": "Indicates if the folder can be synced by Desktop Sync Client." }, "fileLifetime": { "type": "integer", "description": "Time duration (in days) for which the files in this folder are kept after being added to the folder." }, "description": { "type": "string", "description": "The description of the folder." }, "isFavorite": { "type": "boolean", "description": "Indicates if the folder is marked as a favorite by the user." }, "pushedFilesCount": { "type": "integer", "description": "The number of files that have been pushed to mobile apps in this folder." }, "currentUserRole": { "description": "The role of the current user in this folder.", "allOf": [ { "$ref": "#/components/schemas/Role" } ] }, "avStatus": { "type": "string", "description": "The Antivirus (AV) status of the folder." }, "dlpStatus": { "type": "string", "description": "The Data Loss Prevention (DLP) status of the folder." }, "totalMembersCount": { "type": "integer", "description": "Total number of members who have access to this folder." }, "totalFoldersCount": { "type": "integer", "description": "Total number of subfolders within this folder." }, "totalFilesCount": { "type": "integer", "description": "Total number of files within this folder." }, "maxFolderExpiration": { "type": "string", "format": "date", "description": "The maximum expiration date allowed for files in this folder." }, "maxFileLifetime": { "type": "integer", "description": "The maximum duration (in days) that files in this folder can be kept after being added to the folder." }, "isLdapGroupMember": { "type": "boolean", "description": "Indicates if the folder is part of an LDAP group." }, "isUnderMyFolder": { "type": "boolean", "description": "Indicates if this folder is a subfolder of the user's \"My Folder\"." }, "pathIds": { "type": "string", "description": "A list of IDs representing the path of the folder within the folder hierarchy." }, "isRoot": { "type": "boolean", "description": "Indicates if this folder is a root folder." }, "rootId": { "type": "string", "format": "uuid", "description": "The ID of the root folder if this is a subfolder." }, "useFolderQuota": { "type": "boolean", "description": "Indicates if a folder quota is applied to this folder." }, "quota": { "type": "integer", "description": "The storage quota for the folder (in bytes)." }, "size": { "type": "integer", "description": "The total storage size used by the folder (in bytes)." }, "freeSpace": { "type": "integer", "description": "The amount of free space available in the folder (in bytes)." }, "inheritanceEnabled": { "type": "boolean", "description": "Indicates if a folder inherits permissions from the parent folder" } } }, "MetaData": { "type": "object", "properties": { "total": { "type": "integer", "description": "Total number of items available." }, "limit": { "type": "integer", "description": "Maximum number of items returned per page." }, "offset": { "type": "integer", "description": "Number of items skipped before the current page." } } }, "DestinationFolderIdRequest": { "type": "object", "properties": { "destinationFolderId": { "type": "string", "description": "The ID of the destination folder where the item will be copied/moved." }, "addVersion": { "type": "boolean", "description": "If a file with the same name exists, create a new version instead of overwriting it. Default is True." } }, "required": [ "destinationFolderId" ] }, "Folder1": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier (UUID) of the folder." }, "parentId": { "type": "string", "format": "uuid", "description": "Unique identifier (UUID) of the parent object." }, "name": { "type": "string", "description": "Name of the object." }, "type": { "type": "string", "description": "Type of the object.
`f` – File.
`d` – Folder." }, "userId": { "type": "string", "format": "uuid", "description": "Unique identifier (UUID) who created the folder." }, "creator": { "description": "Details of the user who created the object.", "allOf": [ { "$ref": "#/components/schemas/UserBasic" } ] }, "created": { "type": "string", "format": "date", "description": "The date and time when the object was created." }, "modified": { "type": "string", "format": "date", "description": "The date and time when the object was last modified." }, "expire": { "type": "string", "format": "date", "description": "Expiration timestamp of the object, if applicable." }, "permissions": { "description": "List of permissions associated with the object.", "type": "array", "items": { "$ref": "#/components/schemas/Permission" } }, "deleted": { "type": "boolean", "description": "Indicates whether the object has been deleted." }, "permDeleted": { "type": "boolean", "description": "Indicates whether the object has been permanently deleted." }, "permalink": { "type": "string", "description": "Permanent URL link to access the object." }, "path": { "type": "string", "description": "Path to the folder in the hierarchy." }, "members": { "description": "List of members who have access to the object.", "type": "array", "items": { "$ref": "#/components/schemas/Member" } }, "vendorDocId": { "type": "string", "description": "Vendor document ID associated with the object." }, "vendorDocName": { "type": "string", "description": "Name of the vendor document associated with the object." }, "secure": { "type": "boolean", "description": "Indicates whether the folder or the parent folder containing the file is marked as secure." }, "source": { "type": "integer", "description": "ID representing the source of the object (1 - Salesforce, 2 - Teams)." }, "isShared": { "type": "boolean", "description": "Indicates if the folder is shared with other users." }, "syncable": { "type": "boolean", "description": "Indicates if the folder can be synced by Desktop Sync Client." }, "fileLifetime": { "type": "integer", "description": "Time duration (in days) for which the files in this folder are kept after being added to the folder." }, "description": { "type": "string", "description": "The description of the folder." }, "parent": { "description": "The parent folder of the current folder.", "allOf": [ { "$ref": "#/components/schemas/Folder" } ] }, "isFavorite": { "type": "boolean", "description": "Indicates if the folder is marked as a favorite by the user." }, "pushedFilesCount": { "type": "integer", "description": "The number of files that have been pushed to mobile apps in this folder." }, "currentUserRole": { "description": "The role of the current user in this folder.", "allOf": [ { "$ref": "#/components/schemas/Role" } ] }, "avStatus": { "type": "string", "description": "The Antivirus (AV) status of the folder." }, "dlpStatus": { "type": "string", "description": "The Data Loss Prevention (DLP) status of the folder." }, "totalMembersCount": { "type": "integer", "description": "Total number of members who have access to this folder." }, "totalFoldersCount": { "type": "integer", "description": "Total number of subfolders within this folder." }, "totalFilesCount": { "type": "integer", "description": "Total number of files within this folder." }, "maxFolderExpiration": { "type": "string", "format": "date", "description": "The maximum expiration date allowed for files in this folder." }, "maxFileLifetime": { "type": "integer", "description": "The maximum duration (in days) that files in this folder can be kept after being added to the folder." }, "isLdapGroupMember": { "type": "boolean", "description": "Indicates if the folder is part of an LDAP group." }, "isUnderMyFolder": { "type": "boolean", "description": "Indicates if this folder is a subfolder of the user's \"My Folder\"." }, "pathIds": { "type": "string", "description": "A list of IDs representing the path of the folder within the folder hierarchy." }, "isRoot": { "type": "boolean", "description": "Indicates if this folder is a root folder." }, "rootId": { "type": "string", "format": "uuid", "description": "The ID of the root folder if this is a subfolder." }, "useFolderQuota": { "type": "boolean", "description": "Indicates if a folder quota is applied to this folder." }, "quota": { "type": "integer", "description": "The storage quota for the folder (in bytes)." }, "size": { "type": "integer", "description": "The total storage size used by the folder (in bytes)." }, "freeSpace": { "type": "integer", "description": "The amount of free space available in the folder (in bytes)." }, "inheritanceEnabled": { "type": "boolean", "description": "Indicates if a folder inherits permissions from the parent folder" } } }, "Errors": { "type": "object", "properties": { "error": { "type": "array", "items": { "$ref": "#/components/schemas/Error" } } } }, "FolderSendMessageRequest": { "type": "object", "properties": { "to": { "type": "array", "description": "List of recipient user UUIDs (To field).", "items": { "type": "string" } }, "cc": { "type": "array", "description": "List of recipient user UUIDs (CC field).", "items": { "type": "string" } }, "bcc": { "type": "array", "description": "List of recipient user UUIDs (BCC field).", "items": { "type": "string" } }, "secureBody": { "type": "boolean", "description": "If true, the message body is hidden from the notification email and is only visible to recipients when they open the secure link." }, "body": { "type": "string", "description": "The body content of the email." }, "subject": { "type": "string", "maxLength": 998, "description": "The subject of the email (maximum length: 998 characters)." } }, "required": [ "subject" ] }, "Mail": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier of the email." }, "senderId": { "type": "string", "description": "Unique identifier of the sender." }, "templateId": { "type": "integer", "description": "Unique identifier of the email template used." }, "status": { "type": "string", "description": "Current status of the email (e.g., sent, draft, error, etc.)." }, "type": { "type": "string", "description": "Type of the email (e.g., original, reply, forward, etc.)." }, "date": { "type": "string", "format": "date", "description": "Date the email was last modified or sent." }, "deleted": { "type": "boolean", "description": "Indicates if the email has been deleted." }, "withdrawnDate": { "type": "string", "format": "date", "description": "Date when the email was withdrawn, if applicable." }, "emailPackageId": { "type": "string", "description": "Unique identifier of the associated email package." }, "isPreview": { "type": "boolean", "description": "Indicates whether the email is a view-only version, typically used for previewing attachments without enabling downloading." }, "isUserSent": { "type": "boolean", "description": "Indicates whether the email was sent by the current user or another user." }, "watermark": { "type": "string", "description": "Text watermark applied to the email attachments (applicable only for view-only version)." }, "variables": { "description": "List of dynamic variables used in the email.", "type": "array", "items": { "$ref": "#/components/schemas/Variables" } }, "recipients": { "description": "List of recipients for the email.", "type": "array", "items": { "$ref": "#/components/schemas/Recipient" } }, "secureBody": { "type": "boolean", "description": "Indicates if the email body is secured." }, "modifiedDate": { "type": "string", "format": "date", "description": "Date the email was last modified." }, "parentEmailId": { "type": "string", "description": "Unique identifier of the parent email, if applicable." }, "emailReturnReceipt": { "description": "List of recipients who requested return receipts.", "type": "array", "items": { "$ref": "#/components/schemas/EmailReturnRecipient" } }, "error": { "type": "string", "description": "Error message associated with the email, if any." }, "subject": { "type": "string", "description": "Subject line of the email." }, "attachmentCount": { "type": "integer", "description": "Number of attachments in the email." }, "expirationDate": { "type": "string", "format": "date", "description": "Expiration date of the email package, if applicable." }, "avStatus": { "type": "string", "description": "Antivirus (AV) scan status of the email." }, "dlpStatus": { "type": "string", "description": "Data Loss Prevention (DLP) scan status of the email." }, "hasTrackingAccess": { "type": "boolean", "description": "Indicates if tracking access is enabled for the email." }, "trackingAccess": { "description": "List of recipients with tracking access.", "type": "array", "items": { "$ref": "#/components/schemas/TrackingAccessRecipient" } }, "policyDirective": { "type": "integer", "description": "Indicates the restriction type applied to the email" }, "isRead": { "type": "boolean", "description": "Indicates if the email has been read." }, "bucket": { "type": "string", "description": "The bucket where the email is stored. (e.g. inbox, sent, trash)" }, "body": { "type": "string", "description": "The body of the email." }, "package": { "description": "Details of the associated email package.", "allOf": [ { "$ref": "#/components/schemas/Package" } ] }, "rawBody": { "type": "string", "description": "Raw email body content without HTML markup." }, "headline": { "type": "string", "description": "Headline or main title of the email." }, "notice": { "type": "string", "description": "Notice part of the email." }, "fullHtmlBody": { "type": "string", "description": "Full HTML body of the email." }, "emailFrom": { "type": "string", "description": "The email address from which the email was sent." }, "templateBody": { "type": "string", "description": "Body content generated from the email template." }, "webFormId": { "type": "string", "description": "Unique identifier of the web form associated with the email." }, "webFormFields": { "description": "Fields included in the associated web form with the mail." }, "sender": { "description": "Details of the sender.", "allOf": [ { "$ref": "#/components/schemas/UserBasic" } ] }, "sharedMailboxId": { "type": "string", "description": "Unique identifier of the shared mailbox, if applicable." }, "htmlBody": { "type": "string", "description": "HTML version of the email body." }, "actor": { "description": "The user responsible for sending the email, applicable when the email is sent on behalf of a shared mailbox.", "allOf": [ { "$ref": "#/components/schemas/UserBasic" } ] }, "darkModeStyle": { "type": "string", "description": "CSS styles applied for dark mode." }, "exists": { "type": "boolean", "description": "Indicates whether the email already exists in the system." } } }, "FolderCreatePostRequest": { "type": "object", "properties": { "name": { "type": "string", "maxLength": 255, "description": "The name of the new folder (maximum 255 characters)." }, "secure": { "type": "boolean", "description": "Marks the folder as secure, restricting access to authorised recipients only. Can only be set on top-level folders under the user's root folder." }, "syncable": { "type": "boolean", "description": "Indicates whether the folder can be synced by the Desktop Sync Client. Can only be set on top-level folders." }, "expire": { "type": "string", "format": "date", "description": "The folder expiration date. Applicable to top-level folders only." }, "fileLifetime": { "type": "integer", "nullable": true, "minimum": 0, "description": "Number of days files are retained in this folder before expiring. Set to 0 for no expiration. Applicable to top-level folders." }, "rename": { "type": "boolean", "description": "If true, automatically renames the folder if a folder with the same name already exists in the destination." }, "description": { "type": "string", "description": "Optional description for the folder." }, "clientId": { "type": "string", "description": "Client application identifier used to associate the folder with a specific plugin or integration." }, "vendorDocId": { "type": "string", "nullable": true, "description": "External vendor document ID to link this folder to a document in a third-party system." }, "vendorDocName": { "type": "string", "nullable": true, "description": "Display name of the linked vendor document." }, "isFolderUpload": { "type": "boolean", "description": "Indicates whether this folder is being created as part of a folder upload operation. For internal use only." }, "useFolderQuota": { "type": "boolean", "description": "Indicates whether this is a system folder with its own dedicated storage quota." }, "quota": { "type": "integer", "enum": [ 1073741824, 2147483648, 5368709120, 10737418240, 53687091200, -1 ], "description": "Storage quota for the folder in bytes. Must be one of the permitted sizes: 1 GB (1,073,741,824), 2 GB (2,147,483,648), 5 GB (5,368,709,120), 10 GB (10,737,418,240), 50 GB (53,687,091,200), or -1 for unlimited." }, "inheritanceEnabled": { "type": "boolean", "description": "Indicates whether the folder inherits member permissions from its parent folder." } }, "required": [ "name" ] }, "Members": { "type": "object", "properties": { "data": { "description": "List of members with access to the object.", "type": "array", "items": { "$ref": "#/components/schemas/Member" } }, "metadata": { "description": "Pagination metadata for the result set.", "allOf": [ { "$ref": "#/components/schemas/MetaData" } ] } } }, "FolderMemberPostRequest": { "type": "object", "properties": { "notify": { "type": "boolean", "description": "If set to `true`, notifies the user being invited to the folder via email." }, "emails": { "type": "array", "description": "List of email addresses for new members.", "items": { "type": "string", "format": "email" } }, "userIds": { "type": "array", "description": "List of user IDs for new members.", "items": { "type": "string" } }, "ldapGroupIds": { "type": "array", "description": "List of LDAP group IDs for new members.", "items": { "type": "integer" } }, "roleId": { "type": "integer", "description": "The role ID to assign to the new members." }, "notifyFileAdded": { "type": "boolean", "description": "If set to `true`, subscribes the user to notifications for file additions." } }, "required": [ "roleId" ] }, "FolderFileAddMembers": { "type": "object", "properties": { "errors": { "type": "array", "items": { "$ref": "#/components/schemas/ErrorStringSchemaAccessVerifications" } }, "successIds": { "type": "array", "description": "List of succeeded IDs.", "items": { "type": "string" } }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/Member" } } } }, "MemberGroup": { "description": "Class MemberGroup", "required": [ "groupId", "objectId", "roleId" ], "properties": { "objectId": { "description": "Unique identifier of the folder this member belongs to", "type": "string" }, "roleId": { "description": "Unique identifier of the role assigned to this member", "type": "integer" }, "group": { "description": "Details of the LDAP group that is a member (Explicit field. May be retrieved only if mentioned in \"with\" parameter)", "$ref": "#/components/schemas/LdapGroup" }, "role": { "description": "Details of the role assigned to this member (Explicit field. May be retrieved only if mentioned in \"with\" parameter)", "$ref": "#/components/schemas/Role" }, "inheritRoleId": { "description": "Unique identifier of the role inherited from the parent folder (Explicit field. May be retrieved only if mentioned in \"with\" parameter)", "type": "integer" }, "allowedFolderRoleId": { "description": "List of role identifiers that are permitted for this folder membership (Explicit field. May be retrieved only if mentioned in \"with\" parameter)", "type": "array", "items": { "type": "string" } }, "links": { "description": "HATEOAS links associated with the entity", "type": "array", "items": { "type": "string" } }, "groupId": { "description": "Unique identifier of the LDAP group assigned as a member", "type": "integer" }, "user": { "description": "Details of the user who is a member (Explicit field. May be retrieved only if mentioned in \"with\" parameter)", "$ref": "#/components/schemas/User" } } }, "MemberGroup.Put": { "description": "Class MemberGroup", "required": [ "roleId" ], "properties": { "roleId": { "description": "Unique identifier of the role to assign to this member", "type": "integer" }, "notifyFileAdded": { "description": "Indicates whether the member should be notified when a file is added", "type": "boolean" }, "addLinks": { "description": "Indicates whether HATEOAS links should be included in the response", "type": "boolean" } } }, "Member": { "type": "object", "properties": { "objectId": { "type": "string", "description": "Unique identifier (UUID) of the associated object (file or folder)." }, "roleId": { "type": "integer", "description": "Role assigned to the member." }, "userId": { "type": "string", "description": "Unique identifier (UUID) of the user." }, "groupId": { "type": "integer", "description": "Unique identifier of the LDAP group." }, "user": { "description": "User details of the member.", "allOf": [ { "$ref": "#/components/schemas/UserBasic" } ] }, "role": { "description": "Role details assigned to the member.", "allOf": [ { "$ref": "#/components/schemas/Role" } ] }, "group": { "description": "Group details if the member belongs to a group.", "allOf": [ { "$ref": "#/components/schemas/Group" } ] }, "sharedBy": { "description": "Details of the user who shared the file or folder.", "allOf": [ { "$ref": "#/components/schemas/UserBasic" } ] }, "created": { "type": "string", "format": "date", "description": "Date when the file or folder was shared." }, "inheritRoleId": { "type": "integer", "description": "Inherited role ID from the parent folder, if applicable." }, "allowedFolderRoleId": { "type": "array", "description": "List of allowed folder role IDs.", "items": { "type": "integer" } }, "email": { "type": "string", "description": "Email associated with the member." }, "rank": { "type": "integer", "description": "Rank of the member role." }, "originFolder": { "readOnly": true } } }, "Member.Put": { "description": "Class Member", "required": [ "roleId" ], "properties": { "roleId": { "description": "Unique identifier of the role to assign to this member", "type": "integer" }, "notifyFileAdded": { "description": "Indicates whether the member should be notified when a file is added", "type": "boolean" }, "addLinks": { "description": "Indicates whether HATEOAS links should be included in the response", "type": "boolean" }, "notify": { "description": "Indicates whether user would like to receive emails when new member is added into folder", "type": "boolean", "default": true } } }, "Task": { "description": "Class Task", "required": [ "assigneeId", "created", "due", "id", "status", "userId" ], "properties": { "id": { "description": "Task unique identifier", "type": "integer" }, "assigneeId": { "description": "Assigned User unique identifier", "type": "string" }, "assignee": { "description": "User assigned to complete the task (Explicit field. May be retrieved only if mentioned in \"with\" parameter)", "$ref": "#/components/schemas/User" }, "due": { "description": "Date and time by which the task must be completed", "type": "string", "format": "date" }, "parentId": { "description": "Parent Comment identifier", "type": "integer" }, "objectId": { "description": "Object identifier Task belongs to", "type": "string" }, "userId": { "description": "Identifier of User who created a Task", "type": "string" }, "user": { "description": "User who created the task (Explicit field. May be retrieved only if mentioned in \"with\" parameter)", "$ref": "#/components/schemas/User" }, "created": { "description": "Date and time the task was created", "type": "string", "format": "date" }, "modified": { "description": "Date and time the task was last modified", "type": "string", "format": "date" }, "contents": { "description": "Body text of the task", "type": "string" }, "deleted": { "description": "Indicates whether the task is deleted", "type": "boolean" }, "folderId": { "description": "Identifier of Object's parent Folder", "type": "string" }, "status": { "description": "Task status. Accepted values: `D` (Defined), `P` (In Progress), `C` (Completed)", "type": "string" }, "file": { "description": "File the task is tied to (Explicit field. May be retrieved only if mentioned in \"with\" parameter)", "$ref": "#/components/schemas/File" }, "permissions": { "description": "Current user's permissions (Explicit field. May be retrieved only if mentioned in \"with\" parameter)", "type": "array", "items": { "$ref": "#/components/schemas/Permission" } }, "links": { "description": "HATEOAS links associated with the entity", "type": "array", "items": { "type": "string" } } } }, "FolderTreeItem": { "description": "Represents a single node in a folder's ancestor chain, from root down to the target folder.", "properties": { "id": { "description": "The unique identifier of the folder node.", "type": "string" }, "name": { "description": "The display name of the folder node.", "type": "string" } } }, "FolderChildrenFiles": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/File" } }, "metadata": { "$ref": "#/components/schemas/MetaData" } } }, "FolderPermissions": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Permission" } } } }, "MultipleFolderIdRequest": { "type": "object", "properties": { "folderIds": { "type": "array", "description": "A list of folder IDs to be processed.", "items": { "type": "string" } }, "destinationFolderId": { "type": "string", "description": "The destination folder" } }, "required": [ "destinationFolderId", "folderIds" ] }, "BulkOperationMoveFolders": { "type": "object", "properties": { "errors": { "description": "List of errors.", "type": "array", "items": { "$ref": "#/components/schemas/ErrorString" } }, "successIds": { "type": "array", "description": "List of successfully moved folder IDs.", "items": { "type": "string" } }, "data": { "description": "Details of moved folders.", "type": "array", "items": { "$ref": "#/components/schemas/Folder1" } } } }, "FolderQuota": { "type": "object", "properties": { "quota_allowance": { "type": "integer", "description": "Quota allowance allocated to the folder in bytes." }, "storage_available": { "type": "integer", "description": "Storage available for the folder in bytes." }, "storage_quota": { "type": "integer", "description": "Total storage quota assigned to the folder in bytes." }, "storage_used": { "type": "integer", "description": "Storage currently used by the folder in bytes." }, "folder_size": { "type": "integer", "description": "Total size of all files in the folder in bytes." }, "owner_sys_folder_quota_options": { "type": "array", "description": "List of available quota option values (in bytes) for system folders.", "items": { "type": "integer" } } } }, "File": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier (UUID) of the file." }, "parentId": { "type": "string", "format": "uuid", "description": "Unique identifier (UUID) of the parent folder." }, "name": { "type": "string", "description": "Name of the object." }, "type": { "type": "string", "description": "Type of the object.
`f` – File.
`d` – Folder." }, "userId": { "type": "string", "format": "uuid", "description": "Unique identifier (UUID) who created the file." }, "creator": { "description": "Details of the user who created the object.", "allOf": [ { "$ref": "#/components/schemas/UserBasic" } ] }, "created": { "type": "string", "format": "date", "description": "The date and time when the object was created." }, "modified": { "type": "string", "format": "date", "description": "The date and time when the object was last modified." }, "expire": { "type": "string", "format": "date", "description": "Expiration timestamp of the object, if applicable." }, "permissions": { "description": "List of permissions associated with the object.", "type": "array", "items": { "$ref": "#/components/schemas/Permission" } }, "deleted": { "type": "boolean", "description": "Indicates whether the object has been deleted." }, "permDeleted": { "type": "boolean", "description": "Indicates whether the object has been permanently deleted." }, "permalink": { "type": "string", "description": "Permanent URL link to access the file." }, "path": { "type": "string", "description": "Path to the object in the hierarchy." }, "members": { "description": "List of members who have access to the object.", "type": "array", "items": { "$ref": "#/components/schemas/Member" } }, "vendorDocId": { "type": "string", "description": "Vendor document ID associated with the object." }, "vendorDocName": { "type": "string", "description": "Name of the vendor document associated with the object." }, "secure": { "type": "boolean", "description": "Indicates whether the folder or the parent folder containing the file is marked as secure." }, "source": { "type": "integer", "description": "ID representing the source of the object (1 - Salesforce, 2 - Teams)." }, "modifier": { "description": "The user who last modified the file.", "allOf": [ { "$ref": "#/components/schemas/UserBasic" } ] }, "size": { "type": "integer", "description": "The size of the file in bytes." }, "mime": { "type": "string", "description": "The MIME type of the file." }, "fingerprint": { "type": "string", "description": "A unique hash identifying the file." }, "fingerprints": { "type": "array", "description": "List of fingerprints associated with the file.", "items": { "$ref": "#/components/schemas/Fingerprint" } }, "clientCreated": { "type": "string", "format": "date", "description": "The date and time when the file was created on the client side." }, "clientModified": { "type": "string", "format": "date", "description": "The date and time when the file was last modified on the client side." }, "overriddenExpire": { "type": "boolean", "description": "Indicates whether the expiration date for the file has been overridden." }, "sharedBy": { "description": "The user who shared the file.", "allOf": [ { "$ref": "#/components/schemas/UserBasic" } ] }, "sharedTime": { "type": "string", "format": "date", "description": "The date and time when the file was shared." }, "parent": { "description": "The parent folder of the file.", "allOf": [ { "$ref": "#/components/schemas/Folder" } ] }, "originalFileId": { "type": "string", "format": "uuid", "description": "The ID of the original file if this one is a copy." }, "avStatus": { "type": "string", "description": "Indicates the file version's availability status based on Antivirus (AV) settings and whether it has been scanned or detected as infected." }, "dlpStatus": { "type": "string", "description": "Indicates the file version's availability status based on Data Loss Prevention (DLP) settings and whether it has been scanned or detected as infected." }, "adminQuarantineStatus": { "type": "string", "description": "Indicates the file version's availability status based on the administrator's quarantine status." }, "locked": { "type": "boolean", "description": "Indicates if the file is locked." }, "lockUser": { "description": "The user who locked the file.", "allOf": [ { "$ref": "#/components/schemas/UserBasic" } ] }, "isShared": { "type": "boolean", "description": "Indicates if the file is shared with other users." }, "lastModifiedBy": { "description": "The user who last modified the file.", "allOf": [ { "$ref": "#/components/schemas/UserBasic" } ] }, "pushedObject": { "description": "Details about the pushed object, if any.", "allOf": [ { "$ref": "#/components/schemas/PushedObject" } ] }, "pathIds": { "type": "string", "format": "uuid", "description": "A list of IDs representing the path of the file within the folder hierarchy." }, "wopiapp": { "description": "WOPI-related information for the file when used in a mobile app.", "allOf": [ { "$ref": "#/components/schemas/MobileInfo" } ] }, "pushed": { "type": "boolean", "description": "Indicates if the file has been pushed to a mobile app." }, "tags": { "description": "List of tags associated with the file.", "type": "array", "items": { "$ref": "#/components/schemas/Tag" } }, "safeEdit": { "description": "Information regarding the file's SafeEdit settings.", "allOf": [ { "$ref": "#/components/schemas/SafeEdit" } ] }, "versionsCount": { "type": "integer", "description": "The total number of versions for the file." }, "tracking_id": { "type": "string", "format": "uuid", "nullable": true, "description": "Tracking identifier associated with the file upload." } } }, "Folders": { "type": "object", "properties": { "data": { "description": "List of folders.", "type": "array", "items": { "$ref": "#/components/schemas/Folder1" } }, "metadata": { "description": "Pagination metadata for the result set.", "allOf": [ { "$ref": "#/components/schemas/FoldersMetaData" } ] } } }, "FolderUpdatePutRequest": { "type": "object", "properties": { "name": { "type": "string", "maxLength": 255, "description": "New name for the folder (maximum 255 characters)." }, "description": { "type": "string", "description": "Updated description for the folder." }, "syncable": { "type": "boolean", "description": "Indicates whether the folder can be synced by the Desktop Sync Client. Can only be set on top-level folders." }, "expire": { "type": "string", "format": "date", "description": "The folder expiration date. Applicable to top-level folders only." }, "fileLifetime": { "type": "integer", "nullable": true, "minimum": 0, "description": "Number of days files are retained in this folder before expiring. Set to 0 for no expiration." }, "applyFileLifetimeToFiles": { "type": "boolean", "description": "If true, applies the updated `fileLifetime` setting to all existing files in this folder." }, "applyFileLifetimeToNested": { "type": "boolean", "description": "If true, applies the updated `fileLifetime` setting to all nested subfolders." }, "secure": { "type": "boolean", "description": "Marks the folder as secure, restricting access to authorised recipients only. Can only be set on top-level folders under the user's root folder." }, "clientId": { "type": "string", "description": "Client application identifier used to associate the folder with a specific plugin or integration." }, "vendorDocId": { "type": "string", "description": "External vendor document ID to link this folder to a document in a third-party system." }, "vendorDocName": { "type": "string", "description": "Display name of the linked vendor document." }, "useFolderQuota": { "type": "boolean", "description": "Indicates whether this is a system folder with its own dedicated storage quota." }, "quota": { "type": "integer", "enum": [ 1073741824, 2147483648, 5368709120, 10737418240, 53687091200, -1 ], "description": "Storage quota for the folder in bytes. Must be one of the permitted sizes: 1 GB (1,073,741,824), 2 GB (2,147,483,648), 5 GB (5,368,709,120), 10 GB (10,737,418,240), 50 GB (53,687,091,200), or -1 for unlimited." }, "breakInheritance": { "type": "boolean", "description": "If true, breaks permission inheritance from the parent folder, making this folder's members independent. Only `true` is accepted; passing `false` is invalid." } } }, "ActivityList": { "type": "object", "properties": { "data": { "type": "array", "description": "List of activity events.", "items": { "$ref": "#/components/schemas/Activity" } } } }, "AdminFolderPutRequest": { "type": "object", "properties": { "ids": { "type": "array", "description": "List of folder object IDs to be updated.", "items": { "type": "string" } }, "expire": { "type": "string", "format": "date", "description": "Expiration date for the folder." }, "applyTo": { "type": "string", "enum": [ "folders_only", "files_only", "folders_and_files" ], "description": "Defines the scope of the expiration update.
`folders` – Apply expiration to folders only.
`files` – Apply expiration to files only.
`folders_and_files` – Apply expiration to both folders and files." }, "quota": { "type": "integer", "enum": [ 1073741824, 2147483648, 5368709120, 10737418240, 53687091200, -1 ], "description": "Storage quota for the folder in bytes. Must be one of the permitted sizes: 1 GB (1,073,741,824), 2 GB (2,147,483,648), 5 GB (5,368,709,120), 10 GB (10,737,418,240), 50 GB (53,687,091,200), or -1 for unlimited." }, "applyToNestedFiles": { "type": "boolean", "description": "If set to `true`, expiration will also apply to files in child folders." } }, "required": [ "ids" ] }, "Activity": { "type": "object", "properties": { "id": { "type": "integer", "description": "Unique identifier of the activity event." }, "created": { "type": "string", "format": "date", "description": "Date and time when the activity event was recorded." }, "event": { "type": "string", "description": "Name of the activity event." }, "message": { "type": "string", "description": "Human-readable summary of the activity event." }, "type": { "type": "string", "description": "Type category of the activity event." }, "successful": { "type": "boolean", "description": "Indicates whether the activity completed successfully." }, "user": { "description": "Details of the user who performed the activity.", "allOf": [ { "$ref": "#/components/schemas/ActivityUser" } ] }, "permissions": { "type": "array", "description": "List of permissions required for the activity.", "items": { "type": "string" } }, "data": { "readOnly": true, "description": "Additional event-specific data associated with the activity." } } }, "ActivityUser": { "type": "object", "properties": { "userId": { "type": "string" }, "name": { "type": "string", "description": "Full name of the user." }, "email": { "type": "string", "description": "Email address associated with the user." }, "profileIcon": { "type": "string", "description": "URL or identifier for the user's profile icon." } } }, "FoldersMetaData": { "type": "object", "properties": { "total": { "type": "integer", "description": "Total number of items available." }, "limit": { "type": "integer", "description": "Maximum number of items returned per page." }, "offset": { "type": "integer", "description": "Number of items skipped before the current page." }, "totalDeletedFoldersCount": { "type": "integer", "description": "Total number of deleted folders." }, "totalDeletedFilesCount": { "type": "integer", "description": "Total number of deleted files." } } }, "UserBasic": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier (UUID) for the user." }, "email": { "type": "string", "description": "Email address associated with the user." }, "name": { "type": "string", "description": "Full name of the user." }, "profileIcon": { "type": "string", "description": "URL or identifier for the user's profile icon." } } }, "Permission": { "type": "object", "properties": { "id": { "type": "integer", "description": "Unique identifier for the permission." }, "name": { "type": "string", "description": "Name of the permission." }, "allowed": { "type": "boolean", "description": "Indicates whether the permission is granted (True) or denied (False)." } } }, "Fingerprint": { "type": "object", "properties": { "algo": { "type": "string", "description": "The algorithm used to generate the fingerprint (e.g., sha3-256, md5)." }, "hash": { "type": "string", "description": "The resulting hash value representing the fingerprint of the file or object." } } }, "PushedObject": { "type": "object", "properties": { "objectId": { "type": "string", "description": "Unique identifier (UUID) for the pushed object." }, "userId": { "type": "string", "description": "Unique identifier (UUID) for the user who pushed the object." }, "created": { "type": "string", "format": "date", "description": "The date and time when the object was pushed." }, "user": { "description": "Details of the user who pushed the object.", "allOf": [ { "$ref": "#/components/schemas/UserBasic" } ] } } }, "MobileInfo": { "type": "object", "properties": { "wopiSrc": { "type": "string", "description": "The WOPI (Web Application Open Platform Interface) source URL for the mobile application." }, "userId": { "type": "string", "description": "Unique identifier of the user." }, "service": { "type": "string", "description": "The WOPI service ID." }, "scheme": { "type": "string", "description": "URI scheme used by the mobile application to handle the file." }, "schemeSupport": { "type": "string", "description": "Indicates the level of support the mobile app has for the URI scheme." } } }, "Tag": { "type": "object", "properties": { "guid": { "type": "string", "format": "uuid", "description": "Unique identifier (UUID) for the tag." }, "name": { "type": "string", "description": "Display name of the tag." }, "type": { "type": "string", "description": "Type category of the tag." } } }, "SafeEdit": { "type": "object", "properties": { "safeEditLocked": { "type": "boolean", "description": "Indicates if the file is locked through a SafeEdit session." }, "user": { "description": "The user responsible for locking the file via SafeEdit.", "allOf": [ { "$ref": "#/components/schemas/UserBasic" } ] } } }, "ErrorString": { "type": "object", "properties": { "code": { "type": "string", "description": "Error code" }, "message": { "type": "string", "description": "Error message" }, "field": { "type": "string", "description": "Associated field, if applicable." }, "failedIds": { "type": "array", "description": "List of failed IDs.", "items": { "type": "string" } } } }, "User": { "description": "Class User", "required": [ "basedirId", "email", "id", "mydirId", "name", "syncdirId" ], "properties": { "id": { "description": "The unique identifier of the user", "type": "string" }, "basedirId": { "description": "The unique identifier of the user's root Kiteworks directory.", "type": "string" }, "created": { "description": "Date and time the user account was created", "type": "string", "format": "date" }, "email": { "description": "The user's email", "type": "string" }, "mydirId": { "description": "The unique identifier of the user's mydir system directory.", "type": "string" }, "name": { "description": "The name of the user", "type": "string" }, "syncdirId": { "description": "The unique identifier of the user's 'My Folder'.", "type": "string" }, "userTypeId": { "description": "The unique identifier of the user type (profile).", "type": "integer" }, "internal": { "description": "Indicates whether the user is an internal user", "type": "boolean" }, "profileIcon": { "description": "URL to the user's profile icon image", "type": "string" }, "extDL": { "description": "Indicates whether the user is an External Distribution List", "type": "boolean" }, "metadata": { "description": "List of user's metadata", "type": "array", "items": { "$ref": "#/components/schemas/UserMetadata" } }, "adminRoleId": { "description": "The ID of the admin role assigned to the user.", "type": "integer" }, "links": { "description": "HATEOAS links associated with the entity", "type": "array", "items": { "type": "string" } }, "active": { "description": "Indicates whether the user is an actual kitework user", "type": "boolean" }, "suspended": { "description": "Indicates whether the user is suspended", "type": "boolean" }, "deleted": { "description": "Indicates whether the user has been deleted", "type": "boolean" }, "flags": { "description": "Authentication type.\n * 0: No authentication,\n * 1: Authentication by kiteworks,\n * 2: Authentication by LDAP,\n * 4: Authentication by SSO", "type": "integer" }, "verified": { "description": "Indicates whether the user is verified", "type": "boolean" }, "deactivated": { "description": "Indicates whether the user has been deactivated", "type": "boolean" }, "lastActivityDateTime": { "description": "User's last activity datetime", "type": "string", "format": "date" }, "passwordExpirationDateTime": { "description": "The exact timestamp when the user's password will expire", "type": "string", "format": "date" } } }, "UserMetadata": { "description": "Class UserMetadata", "properties": { "name": { "description": "Key name of the custom metadata attribute associated with the user", "type": "string" }, "value": { "description": "Value assigned to the custom metadata attribute for the user", "type": "string" } } }, "Role": { "type": "object", "properties": { "id": { "type": "integer", "description": "Role ID" }, "name": { "type": "string", "description": "Role name" }, "rank": { "type": "integer", "description": "Role rank" }, "type": { "type": "string", "description": "Role type" } } }, "Group": { "type": "object", "properties": { "id": { "type": "integer", "description": "LDAP Group ID" }, "name": { "type": "string", "description": "LDAP Group name" }, "dn": { "type": "string", "description": "LDAP Group domain name" }, "email": { "type": "string", "description": "LDAP Group email" }, "description": { "type": "string", "description": "LDAP Group description" } } }, "LdapGroup": { "description": "Class LdapGroup", "required": [ "id", "name" ], "properties": { "id": { "description": "LDAP group unique identifier", "type": "integer" }, "name": { "description": "Display name of the LDAP group", "type": "string" }, "email": { "description": "LDAP group email address", "type": "string" }, "description": { "description": "LDAP group description", "type": "string" }, "links": { "description": "HATEOAS links associated with the entity", "type": "array", "items": { "type": "string" } } } }, "ErrorStringSchemaAccessVerifications": { "type": "object", "properties": { "code": { "type": "string", "description": "Error code" }, "message": { "type": "string", "description": "Error message" }, "field": { "type": "string", "description": "Associated field, if applicable." }, "failedIds": { "type": "array", "description": "List of failed IDs.", "items": { "type": "string" } }, "accessVerification": { "description": "Access Verification details", "allOf": [ { "$ref": "#/components/schemas/AccessVerificationApproval" } ] }, "referenceId": { "type": "string", "description": "Reference ID for the error" } } }, "AccessVerificationApproval": { "type": "object", "properties": { "id": { "type": "string", "description": "Access Verification ID" }, "parentId": { "type": "integer", "description": "Unique identifier of the parent object." }, "name": { "type": "string", "description": "Name of the object." }, "type": { "type": "string", "description": "Type of the object.
`f` – File.
`d` – Folder." }, "userId": { "type": "string", "format": "uuid", "description": "Unique identifier (UUID) who created the object." }, "creator": { "description": "Details of the user who created the object.", "allOf": [ { "$ref": "#/components/schemas/UserBasic" } ] }, "created": { "type": "string", "format": "date", "description": "The date and time when the object was created." }, "modified": { "type": "string", "format": "date", "description": "The date and time when the object was last modified." }, "expire": { "type": "string", "format": "date", "description": "Expiration timestamp of the object, if applicable." }, "permissions": { "description": "List of permissions associated with the object.", "type": "array", "items": { "$ref": "#/components/schemas/Permission" } }, "deleted": { "type": "boolean", "description": "Indicates whether the object has been deleted." }, "permDeleted": { "type": "boolean", "description": "Indicates whether the object has been permanently deleted." }, "permalink": { "type": "string", "description": "Permanent URL link to access the object." }, "path": { "type": "string", "description": "Path to the object in the hierarchy." }, "members": { "description": "List of members who have access to the object.", "type": "array", "items": { "$ref": "#/components/schemas/Member" } }, "vendorDocId": { "type": "string", "description": "Vendor document ID associated with the object." }, "vendorDocName": { "type": "string", "description": "Name of the vendor document associated with the object." }, "secure": { "type": "boolean", "description": "Indicates whether the folder or the parent folder containing the file is marked as secure." }, "source": { "type": "integer", "description": "ID representing the source of the object (1 - Salesforce, 2 - Teams)." }, "requirements": { "type": "array", "description": "List of requirements for access verification", "items": { "$ref": "#/components/schemas/Requirement" } } } }, "Requirement": { "type": "object", "properties": { "id": { "type": "string", "description": "Requirement ID" }, "parentId": { "type": "integer", "description": "Unique identifier of the parent object." }, "name": { "type": "string", "description": "Name of the object." }, "type": { "type": "string", "description": "Type of the object.
`f` – File.
`d` – Folder." }, "userId": { "type": "string", "format": "uuid", "description": "Unique identifier (UUID) who created the object." }, "creator": { "description": "Details of the user who created the object.", "allOf": [ { "$ref": "#/components/schemas/UserBasic" } ] }, "created": { "type": "string", "format": "date", "description": "The date and time when the object was created." }, "modified": { "type": "string", "format": "date", "description": "The date and time when the object was last modified." }, "expire": { "type": "string", "format": "date", "description": "Expiration timestamp of the object, if applicable." }, "permissions": { "description": "List of permissions associated with the object.", "type": "array", "items": { "$ref": "#/components/schemas/Permission" } }, "deleted": { "type": "boolean", "description": "Indicates whether the object has been deleted." }, "permDeleted": { "type": "boolean", "description": "Indicates whether the object has been permanently deleted." }, "permalink": { "type": "string", "description": "Permanent URL link to access the object." }, "path": { "type": "string", "description": "Path to the object in the hierarchy." }, "members": { "description": "List of members who have access to the object.", "type": "array", "items": { "$ref": "#/components/schemas/Member" } }, "vendorDocId": { "type": "string", "description": "Vendor document ID associated with the object." }, "vendorDocName": { "type": "string", "description": "Name of the vendor document associated with the object." }, "secure": { "type": "boolean", "description": "Indicates whether the folder or the parent folder containing the file is marked as secure." }, "source": { "type": "integer", "description": "ID representing the source of the object (1 - Salesforce, 2 - Teams)." }, "approvers": { "description": "List of approvers for the requirement" }, "asset_class": { "description": "Asset class associated with the requirement", "allOf": [ { "$ref": "#/components/schemas/RiskPolicy" } ] }, "matched_recipients": { "type": "array", "description": "List of succeeded recipient emails.", "items": { "type": "string" } } } }, "RiskPolicy": { "type": "object", "properties": { "id": { "type": "string", "description": "Risk Policy ID" }, "parentId": { "type": "integer", "description": "Unique identifier of the parent object." }, "name": { "type": "string", "description": "Risk Policy Name" }, "type": { "type": "string", "description": "Type of the object.
`f` – File.
`d` – Folder." }, "userId": { "type": "string", "format": "uuid", "description": "Unique identifier (UUID) who created the object." }, "creator": { "description": "Details of the user who created the object.", "allOf": [ { "$ref": "#/components/schemas/UserBasic" } ] }, "created": { "type": "string", "format": "date", "description": "The date and time when the object was created." }, "modified": { "type": "string", "format": "date", "description": "The date and time when the object was last modified." }, "expire": { "type": "string", "format": "date", "description": "Expiration timestamp of the object, if applicable." }, "permissions": { "description": "List of permissions associated with the object.", "type": "array", "items": { "$ref": "#/components/schemas/Permission" } }, "deleted": { "type": "boolean", "description": "Indicates whether the object has been deleted." }, "permDeleted": { "type": "boolean", "description": "Indicates whether the object has been permanently deleted." }, "permalink": { "type": "string", "description": "Permanent URL link to access the object." }, "path": { "type": "string", "description": "Path to the object in the hierarchy." }, "members": { "description": "List of members who have access to the object.", "type": "array", "items": { "$ref": "#/components/schemas/Member" } }, "vendorDocId": { "type": "string", "description": "Vendor document ID associated with the object." }, "vendorDocName": { "type": "string", "description": "Name of the vendor document associated with the object." }, "secure": { "type": "boolean", "description": "Indicates whether the folder or the parent folder containing the file is marked as secure." }, "source": { "type": "integer", "description": "ID representing the source of the object (1 - Salesforce, 2 - Teams)." }, "message": { "type": "string", "description": "Risk Policy Message" } } }, "Variables": { "type": "object", "properties": { "variable": { "type": "string", "description": "The variable name" }, "value": { "description": "The variable value" } } }, "Recipient": { "type": "object", "properties": { "userId": { "type": "string", "description": "Unique identifier of the user associated with the recipient." }, "type": { "type": "integer", "description": "Recipient type.
`0` – To.
`1` – CC.
`2` – BCC." }, "email": { "type": "string", "description": "Email address of the recipient." }, "isDistributionList": { "type": "boolean", "description": "Indicates if the recipient is a distribution list rather than an individual user." }, "user": { "description": "Details of the user associated with the recipient.", "allOf": [ { "$ref": "#/components/schemas/UserBasic" } ] } } }, "EmailReturnRecipient": { "type": "object", "properties": { "userId": { "type": "string", "description": "Unique identifier of the user who requested the return receipt." }, "user": { "description": "Details of the user who requested the return receipt.", "allOf": [ { "$ref": "#/components/schemas/UserBasic" } ] } } }, "TrackingAccessRecipient": { "type": "object", "properties": { "userId": { "type": "string", "description": "Unique identifier of the user associated with the recipient." }, "type": { "type": "integer", "description": "Recipient type.
`0` – To.
`1` – CC.
`2` – BCC." }, "email": { "type": "string", "description": "Email address of the recipient." }, "isDistributionList": { "type": "boolean", "description": "Indicates if the recipient is a distribution list rather than an individual user." }, "user": { "description": "Details of the user associated with the recipient.", "allOf": [ { "$ref": "#/components/schemas/UserBasic" } ] }, "revoked": { "type": "boolean", "description": "Indicates whether the recipient's tracking access has been revoked." } } }, "Package": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier of the email package." }, "selfCopy": { "type": "boolean", "description": "Indicates whether the package includes a copy for the sender." }, "includeFingerprint": { "type": "boolean", "description": "Indicates whether a fingerprint (hash) of the package should be included for verification." }, "expire": { "type": "integer", "description": "Expiration time of the package in seconds from creation." }, "fileCount": { "readOnly": true, "description": "Count of the files attached to the package." }, "deleted": { "type": "boolean", "description": "Indicates whether the package has been marked as deleted." }, "acl": { "type": "string", "description": "Access control list (ACL) associated with the package, specifying who can access it." }, "attachments": { "description": "List of attachments included in the package.", "type": "array", "items": { "$ref": "#/components/schemas/Attachment" } }, "downloadLink": { "type": "string", "description": "Link for accessing the email." } } }, "Attachment": { "type": "object", "properties": { "emailPackageId": { "type": "string", "format": "uuid", "description": "Unique identifier for the email package containing the attachment." }, "attachmentId": { "type": "string", "description": "Unique identifier for the attachment." }, "withdrawn": { "type": "boolean", "description": "Indicates whether the attachment has been withdrawn." }, "drmFile": { "description": "Details of the DRM-protected file associated with the attachment.", "allOf": [ { "$ref": "#/components/schemas/DrmFile" } ] }, "accessType": { "type": "integer", "description": "Access type for the attachment (e.g., read-only, editable)." }, "tags": { "description": "List of tags associated with the attachment.", "type": "array", "items": { "$ref": "#/components/schemas/Tag" } }, "permissions": { "type": "array", "description": "List of permissions associated with the attachment.", "items": { "$ref": "#/components/schemas/Permission" } }, "objectId": { "type": "string", "format": "uuid", "description": "Unique identifier for the file associated with the attachment." }, "name": { "type": "string", "description": "Name of the attachment file." }, "size": { "type": "integer", "description": "Size of the attachment file in bytes." }, "mime": { "type": "string", "description": "The MIME type of the attachment file." }, "created": { "type": "string", "format": "date", "description": "Date when the attachment file was created." }, "deleted": { "type": "boolean", "description": "Indicates if the attachment has been deleted." }, "fingerprint": { "type": "string", "description": "A unique hash identifying the file version." }, "fingerprintAlgo": { "type": "string", "description": "The algorithm used for generating the file version fingerprint. (e.g., sha3-256, md5)." }, "fingerprints": { "description": "List of alternative fingerprints for the attachment file.", "type": "array", "items": { "$ref": "#/components/schemas/Fingerprint" } }, "adminQuarantineStatus": { "type": "string", "description": "Status of the attachment in the admin quarantine system." }, "avStatus": { "type": "string", "description": "Antivirus (AV) scan status of the attachment." }, "dlpStatus": { "type": "string", "description": "Data Loss Prevention (DLP) status of the attachment." } } }, "DrmFile": { "type": "object", "properties": { "name": { "type": "string", "description": "Name of the DRM-protected file." }, "size": { "type": "integer", "description": "Size of the DRM-protected file in bytes." } } }, "Error": { "type": "object", "properties": { "code": { "type": "string", "description": "Error code" }, "message": { "type": "string", "description": "Error message" } } } } } }