{ "swagger": "2.0", "info": { "version": "1", "title": "MOVEit Transfer REST API", "x-swagger-net-version": "8.5.28.001", "x-logo": { "url": "images/MOVEitLogo.svg" }, "description": "**Release 2025.1**, **version 17.01** \n\n\n *MOVEit securely collects, stores, manages, and distributes information within organizations, between businesses, and more...*\n\n \n \n > **Important!**\n The REST API is an optionally licensed feature that runs at the MOVEit Transfer Server. It is subject to the terms of \n the [MOVEit Transfer End User License Agreement](https://www.progress.com/legal/license-agreements/progress-ipswitch).\n\n\n \n \n![ Contexts ](images/Contexts.png)\n \n \n Overview\n\n ========\n\n \n The REST API enables you to develop, integrate, and deploy applications that need secure data and managed file transfer as part of their workflow.\n Feeding or saving files with data governed by data security standards such as HIPAA, PCI, GDPR, and more are some obvious examples where this would be necessary.\n\n \n Using the Transfer REST API (instead of the Transfer .NET or Java API)\n enables you to connect systems and clients to MOVEit Transfer using\n simple HTTP calls. In general, REST APIs are language and platform\n independent and can be your best choice to converge information systems,\n circumvent the unending need for client-server dependency maintenance,\n and span any combination of environments (including IoT, mobile, and\n much more).\n\n \n > **Tip**\n The REST API is mapped to run at\n [https://<your-transfer-server>/api/v1/](https:///api/v1/)).\n --Where <your-transfer-server> is the host where your MOVEit Transfer Server is running. \n\n\n \n \n > **Note**\n In general, this RESTful API expects the following verbs: GET (query\n record), POST (create/delete record), PATCH (batch modify/update record), or\n DELETE (remove record).\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
This REST EndpointProvides These Resources

1.

/api/v1/token

Manage Access Tokens and Multi-factor Authentication (one-time passwords).

2.

/api/v1/users
\n /api/v1/groups

Create and manage users and groups, roles, home folders, and other properties.

3.

/api/v1/folders

Folders, folder actions, and folder contents.

4.

/api/v1/mailboxes

Manage mailboxes.

5.

/api/v1/files

/api/v1/packages

Manage files and manage packages.

6.

/api/v1/xferstatus

Get status and summaries for ongoing and recently completed transfers.

7.

/api/v1/info

Get information about a MOVEit organization.

8.

/api/v1/folders/{ID}/acls/

Manage folder permissions.

9.

/api/v1/folders/{Id}/acls/{aclsId}

Manage folder permissions for a particular user or group.

10.

/api/v1/packages/{Id}

Full operations set for packages.

11.

/api/v1/contacts/{Id}

Full operations set for contacts.

\n

/swagger

Live Swagger UI interactive documentation (MOVEit Transfer installation required).

\n \n \nBefore You Begin\n\n ================\n\n \n Before you begin using the MOVEit Transfer RESTful API, you will need\n the following:\n \n - The hostname for a deployed MOVEit Transfer system.\n \n - The API endpoint needs to be exposed through the web.config file.\n \n - Username and password for a user on the target MOVEit Transfer\n system.\n \n - Your favorite HTTP client (the examples that follow use the cURL\n utility).\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
ListenerURLPurpose

Swagger UI

https://<your-transfer-server>/swagger

Browsable/interactive UI service available for exercising the REST API.

REST API

https://<your-transfer-server>/api/v1/

Primary REST API Endpoint.

\n \n \nExposing the endpoint from the MOVEit Transfer Host's web.config File\n\n\t\t ------------------------\n\n\t\t \n\t\t By default, the Swagger endpoint is not visible. To make it visible, comment out the following directive in Web.config instruction file. \n\t\t For example:\n\n\t\t \n\t\t \n\t\t ```\n\n {\n\n \n\n \n\n \n\n }\n\n ```\n\n \n > **Note**\n\n\t\t The default location of Web.config is `C:\\Program files\\MOVEit Transfer\\wwwroot\\`. \n\n \n \nA quick check of the API\n\n ------------------------\n\n \n If you are unsure whether or not the REST API is already listening for\n requests on a MOVEit Transfer host, here is a quick check. Type into\n your web browser `https:///api/v1/token`. (Where\n `` is the hostname of the MOVEit Transfer system.)\n If this call returns a simple JSON object, your API is running, and you\n can begin the steps that follow using this hostname. \n\n \n > **Tip**\n\n \n You can also use the Swagger spec object\n (`https:///api/v1/swagger`) in tools such as\n Postman, Swagger Inspector, and more.\n\n \n Interactive REST API Client - Swagger UI\n\n ----------------------------------------\n\n \n Swagger UI libraries integrated with MOVEit Transfer at install time\n provide the following:\n \n - A way to browse the MOVEit Transfer REST documentation with live\n examples.\n \n - A simple development client for testing MOVEit Transfer REST calls.\n \n > **Caution**\n \n The examples are live calls (not simulated) that run against your\n database. If you are just testing and exploring the capabilities of\n The REST API for development purposes, it is best practice to run\n against a non-production instance of MOVEit Transfer.\n\n \n To open the interactive MOVEit Transfer REST client:\n \n 1. Open a browser to `https://my-transfer-host/swagger/` --Where\n `my-transfer-host` is the host where you installed MOVEit Transfer\n \n 2. Browse and build queries and view JSON result objects.\n \n \n![SwaggerUI](images/SwaggerUI.png)\n\n \n \nGetting Started\n\n ===============\n\n \n This section walks you through how to fetch user properties for the\n current user.\n \n > **Tip**\n If you are running an API token request against a non-production host\n with a self-signed SSL certificate needed to run HTTPS, remember to\n set the flag to ignore the self-signed certificate warning. (In the\n cURL example shown below this is the `-k` option.)\n\n\n \n To set your session up with the MOVEit Transfer RESTful API, you must\n retrieve an access token. (Syntax, usage, and fields supported by the\n token endpoint are detailed in [Retrieve API Token](#_auth_gettoken) and\n [Revoke API token](#_auth_revoketoken).)\n\n \n ```\n\n curl -k --request POST --url https://your-transfer-server/api/v1/token --data \"grant_type=password&username=emmacurtis&password=1a2B3cA1b2C3\"\n\n ```\n\n \n \nExample Output\n\n ----------------\n\n \n ```\n\n {\n\n \t\"access_token\": \"X03w.....dziTwmA\",\n\n \t\"token_type\": \"bearer\",\n\n \t\"expires_in\": 86399,\n\n \t\"refresh_token\": \"X03w.....dziTwmA\"\n\n }\n\n ```\n\n \n --Where `your-transfer-server` is the hostname where your MOVEit\n Transfer WebUI is running.\n\n --And, where you supply values for the username and password (such as\n the MOVEit user you created for this RESTful client application).\n\n \n Now, pass the access token as a header argument, type \"Bearer\" and get your user information.\n\n \n ```\n\n curl -H \"Authorization: Bearer X03w.....dziTwmA\" \"https://your-transfer-server/api/v1/users/self\"\n\n ```\n\n \n --Where `your-transfer-server` is the hostname where your MOVEit\n Transfer WebUI is running. \n\n --And, where you should replace the placeholder string `X03wÂ…?..dziTwmA`\n with your 278 Byte access token.\n\n \n Example Output\n\n ----------------\n \n ```{\n\n \t\"emailFormat\": \"HTML\",\n\n \t\"notes\": \"\",\n\n \t\"statusNote\": \"\",\n\n \t\"passwordChangeStamp\": \"2017-04-17T09:36:47\",\n\n \t\"receivesNotification\": \"ReceivesNotifications\",\n\n \t\"forceChangePassword\": false,\n\n \t\"folderQuota\": 0,\n\n \t\"authMethod\": \"MOVEitOnly\",\n\n \t\"language\": \"en\",\n\n \t\"homeFolderID\": 377392666,\n\n \t\"defaultFolderID\": 377392666,\n\n \t\"expirationPolicyID\": 0,\n\n \t\"displaySettings\": {\n\n \t\t\"userListPageSize\": 10,\n\n \t\t\"fileListPageSize\": 100,\n\n \t\t\"liveViewPageSize\": 25,\n\n \t\"id\": \"axaxfbz5v85l7dp1\",\n\n \t\"orgID\": 9683,\n\n \t\"username\": \"org1admin\",\n\n \t\"realname\": \"Denise Taylor\",\n\n \t\"permission\": \"Admin\",\n\n \t\"email\": \"dtaylor@example.com\",\n\n \t\"status\": \"Active\",\n\n \t\"lastLoginStamp\": \"2018-04-06T16:13:50\"\n\n }\n\n ```\n\n \n Now, use the homeFolderID value (`311392888`) and get a list of files in\n the folder.\n\n \n ```\n\n curl -H \"Authorization: Bearer your-access-token\" \"https://your-transfer-server/api/v1/folders/311392888/files\"\n\n ```\n\n \n \nExample Output\n\n ----------------\n\n \n ```\n\n {\n\n \"items\": [\n\n \t{\n\n \t \"id\": \"455123456\",\n\n \t \"name\": \"iMacros-for-Chrome-File-Access-Setup-Mac.dmg\",\n\n \t \"path\": \"/Home/org1admin/iMacros-for-Chrome-File-Access-Setup-Mac.dmg\",\n\n \t \"fileSize\": 4454619,\n\n \t \"uploadStamp\": \"2018-02-08T14:48:08\"\n\n },\n\n {\n\n \t \"id\": \"455123455\",\n\n \t \"name\": \"MOVEit-Client-0.1.0-mac.zip\",\n\n \t \"path\": \"/Home/org1admin/MOVEit-Client-0.1.0-mac.zip\",\n\n \t \"fileSize\": 61725986,\n\n \t \"uploadStamp\": \"2018-02-08T08:58:45\"\n\n }\n\n ],\n\n \t \"currentPage\": 1,\n\n \t \"totalItems\": 2,\n\n \t \"itemsPerPage\": 25,\n\n \t \"sorting\": [\n\n \t{\n\n \t \"sortField\": \"name\",\n\n \t \"sortDirection\": \"asc\"\n\n \t}\n\n ]\n\n }\n\n ```\n\n\n \n \nHandling Session Tokens\n\n =======================\n\n \n Before you can be authorized to access MOVEit Transfer resources using\n this RESTful API, you must request an access token. Only authenticated\n clients can fetch or renew an access token.\n\n \n Request/refresh an access token\n\n -------------------------------\n\n \n HTTPS sessions with MOVEit Transfer begin with a token request. It must\n be sent as an HTTP POST.\n\n \n ```\n\n POST /api/v{version}/token\n\n ```\n\n \n ### *Request Example*\n \n > **Tip**\n If you are running an API token request against a non-production host\n with a self-signed SSL certificate needed to run HTTPS, remember to\n set the flag to ignore the self-signed certificate warning. (In the\n cURL example shown below this is the `-k` option.)\n\n \n ```\n\n curl -k --request POST --url https://mydmzserver/api/v1/token --data \"grant_type=password&username=${username}&password=${password}\"\n\n ```\n\n \n\n \n --Where `mydmzserver` is the hostname where your MOVEit Transfer WebUI\n is running.\n\n \n --And, where `${username}` and `${password}` are the username and\n password you created for the current client application.\n\n \n > **Note**\n For logging purposes, it is best practice to create a new API user\n using the MOVEit Transfer WebUI.\n \n ### *Refresh Example*\n \n ```\n\n curl -X POST https://mydmzserver/api/v1/token -H \"accept: application/json\" -H \"Content-Type: application/x-www-form-urlencoded\" -d \"grant_type=refresh_token&refresh_token=${refresh-token}\"\n\n ```\n\n \n \n--Where `mydmzserver` is the hostname where your MOVEit Transfer WebUI is running.\n\n --And, where `${refresh-token}` is the token received from the last authenticated token request (this request must be submitted within the allowed expiration period).\n\n \n > **Tip**\n Token expiration duration is determined by client session properties configured at the MOVEit Transfer Server.\n\n \n \nToken response messages\n\n -----------------------\n\n \n Response Content Type: application/json\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
HTTP Status CodeMeaningResponse Model

200

SUCCESS

{\n \"access_token\": \"_acaxffz2p3cl1ek8Â…?\",\n \"token_type\": \"bearer\",\n \"expires_in\": 86399,\n \"refresh_token\": \"_ACAXFFZ2P3CL1EK8UÂ…?\",\n }
\n

400

BAD REQUEST

{\n \"error\": \"invalid_grant\",\n \"error_description\": \"Invalid username/password or not allowed to sign on from this location.\"\n }
\n

\n \n \nUse token in request\n\n --------------------\n\n \n After you get your session token you can use the token in subsequent\n requests. You pass the token in the HTTP header as type `Bearer`. For\n example, to get information such as user directory, name, user ID, and\n more for the current user, you would send this cURL GET request that\n passes the token using the `-H` option.\n\n \n ### *Example*\n \n ```\n\n curl -H \"Authorization: Bearer X03w....dziTwmA\" \"https://mydmzserver/api/v1/users/self\"\n\n ```\n\n \n \n--Where `mydmzserver` is the hostname where your MOVEit Transfer WebUI is running.\n \n " }, "host": "127.0.0.1", "schemes": [ "https" ], "paths": { "/api/v1/settings/adhoctransfer/maintenance/agingexpiration": { "get": { "tags": [ "AdHocTransferSettings" ], "summary": "Get aging and expiration in the organization", "operationId": "GETapi/v1/settings/adhoctransfer/maintenance/agingexpiration-1.0", "consumes": [], "produces": [ "application/json", "text/json", "application/problem+json" ], "parameters": [], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/AdHocTransferAgingExpirationModel" } }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/ErrorModel" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "security": [ { "Authorization": [] } ] } }, "/api/v1/settings/appearance/brand/logos": { "post": { "tags": [ "AppearanceSettings" ], "summary": "Update the organization branding logos.", "description": "The content type of the request must be \"multipart/form-data\".", "operationId": "POSTapi/v1/settings/appearance/brand/logos-1.0", "consumes": [ "multipart/form-data" ], "produces": [ "application/json", "text/json", "application/problem+json" ], "parameters": [ { "name": "leftlogo", "in": "formData", "description": "Left logo file", "required": false, "type": "file" }, { "name": "rightlogo", "in": "formData", "description": "Right logo file", "required": false, "type": "file" }, { "name": "backgroundlogo", "in": "formData", "description": "Header background logo file", "required": false, "type": "file" }, { "name": "usecustomnotifbranding", "in": "formData", "description": "Whether to enable or disable custom notification branding (1 or 0)", "required": false, "type": "string" }, { "name": "resetrightlogo", "in": "formData", "description": "When set to 1, resets the right logo to an empty image", "required": false, "type": "string" }, { "name": "resetbackgroundlogo", "in": "formData", "description": "When set to 1, resets the header background logo to an empty image", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/LogosModel" } }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/ErrorModel" } }, "422": { "description": "Invalid Request Parameters", "schema": { "$ref": "#/definitions/UnprocessableEntityErrorModel" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "security": [ { "Authorization": [] } ] } }, "/api/v1/auth/identityproviders": { "get": { "tags": [ "Authentication" ], "summary": "Get list of identity providers in the organization", "operationId": "GETapi/v1/auth/identityproviders?Page={Page}&PerPage={PerPage}&SortField={SortField}&SortDirection={SortDirection}&OrgId={OrgId}-1.0", "consumes": [], "produces": [ "application/json", "text/json", "application/problem+json" ], "parameters": [ { "name": "page", "in": "query", "description": "Page number to display", "required": false, "type": "integer", "format": "int32" }, { "name": "perPage", "in": "query", "description": "Items per page in result collection; Default is 25", "required": false, "type": "integer", "format": "int32" }, { "name": "sortField", "in": "query", "description": "Name of field to sort the results by. (name); Default is Name.", "required": false, "type": "string" }, { "name": "sortDirection", "in": "query", "description": "Sort direction; Default is ascending.", "required": false, "type": "string" }, { "name": "orgId", "in": "query", "description": "Organization Id.", "required": false, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/PagedModelOfPublicIdPInformationModel" } }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/ErrorModel" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "security": [ { "Authorization": [] } ] } }, "/api/v1/auth/actasadmin": { "post": { "tags": [ "Authentication" ], "summary": "Become administrator in specific organization", "operationId": "POSTapi/v1/auth/actasadmin-1.0", "consumes": [ "application/json", "text/json", "application/problem+json" ], "produces": [ "application/json", "text/json", "application/problem+json" ], "parameters": [ { "name": "request", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OrgRequest" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ActAsAdminDto" } }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/ErrorModel" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "security": [ { "Authorization": [] } ] } }, "/api/v1/contacts": { "get": { "tags": [ "Contacts" ], "summary": "List contacts", "operationId": "GETapi/v1/contacts?SearchString={SearchString}&OnBehalfOf={OnBehalfOf}&Page={Page}&PerPage={PerPage}&SortField={SortField}&SortDirection={SortDirection}-1.0", "consumes": [], "produces": [ "application/json", "text/json", "application/problem+json" ], "parameters": [ { "name": "searchString", "in": "query", "description": "Search String. The Name and Email values will be searched.", "required": false, "type": "string" }, { "name": "onBehalfOf", "in": "query", "description": "User to get contacts on behalf of.", "required": false, "type": "string" }, { "name": "page", "in": "query", "description": "Page number to display", "required": false, "type": "integer", "format": "int32" }, { "name": "perPage", "in": "query", "description": "Items per page in result collection; Default is 25", "required": false, "type": "integer", "format": "int32" }, { "name": "sortField", "in": "query", "description": "Name of field to sort the results by. (email, name); Default is Name.", "required": false, "type": "string" }, { "name": "sortDirection", "in": "query", "description": "Sort direction; Default is ascending.", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/PagedModelOfContactModel" } }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/ErrorModel" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "security": [ { "Authorization": [] } ] }, "post": { "tags": [ "Contacts" ], "summary": "Create new contact", "operationId": "POSTapi/v1/contacts-1.0", "consumes": [ "application/json", "text/json", "application/problem+json" ], "produces": [ "application/json", "text/json", "application/problem+json" ], "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/ContactAddModel" } } ], "responses": { "201": { "description": "Created", "schema": { "$ref": "#/definitions/ContactModel" } }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/ErrorModel" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "security": [ { "Authorization": [] } ] } }, "/api/v1/contacts/{Id}": { "delete": { "tags": [ "Contacts" ], "summary": "Delete contact", "operationId": "DELETEapi/v1/contacts/{Id}-1.0", "consumes": [], "produces": [ "application/json", "text/json", "application/problem+json" ], "parameters": [ { "name": "Id", "in": "path", "description": "Contact ID", "required": true, "type": "string" } ], "responses": { "204": { "description": "No Content", "schema": { "$ref": "#/definitions/Void" } }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/ErrorModel" } }, "404": { "description": "Resource Not Found", "schema": { "$ref": "#/definitions/ErrorModel" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "security": [ { "Authorization": [] } ] }, "patch": { "tags": [ "Contacts" ], "summary": "Update existing contact", "operationId": "PATCHapi/v1/contacts/{Id}-1.0", "consumes": [ "application/json", "text/json", "application/problem+json" ], "produces": [ "application/json", "text/json", "application/problem+json" ], "parameters": [ { "name": "Id", "in": "path", "required": true, "type": "string" }, { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/ContactUpdateModel" } } ], "responses": { "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/ErrorModel" } }, "404": { "description": "Resource Not Found", "schema": { "$ref": "#/definitions/ErrorModel" } }, "422": { "description": "Invalid Request Parameters", "schema": { "$ref": "#/definitions/UnprocessableEntityErrorModel" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "security": [ { "Authorization": [] } ] } }, "/api/v1/files/{Id}": { "get": { "tags": [ "Files" ], "summary": "Return file details", "operationId": "GETapi/v1/files/{Id}-1.0", "consumes": [], "produces": [ "application/json", "text/json", "application/problem+json" ], "parameters": [ { "name": "Id", "in": "path", "description": "File ID", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FileDetailsModel" } }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/ErrorModel" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "security": [ { "Authorization": [] } ] }, "delete": { "tags": [ "Files" ], "summary": "Delete file", "operationId": "DELETEapi/v1/files/{Id}-1.0", "consumes": [], "produces": [ "application/json", "text/json", "application/problem+json" ], "parameters": [ { "name": "Id", "in": "path", "description": "File ID", "required": true, "type": "string" } ], "responses": { "204": { "description": "No Content", "schema": { "$ref": "#/definitions/Void" } }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/ErrorModel" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "security": [ { "Authorization": [] } ] }, "patch": { "tags": [ "Files" ], "summary": "Partial file update", "operationId": "PATCHapi/v1/files/{Id}-1.0", "consumes": [ "application/json", "text/json", "application/problem+json" ], "produces": [ "application/json", "text/json", "application/problem+json" ], "parameters": [ { "name": "Id", "in": "path", "description": "ID of the file to update", "required": true, "type": "string" }, { "name": "body", "in": "body", "description": "Request body", "required": true, "schema": { "$ref": "#/definitions/FilePatchModel" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FileDetailsModel" } }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/ErrorModel" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "security": [ { "Authorization": [] } ] } }, "/api/v1/files/{Id}/download": { "get": { "tags": [ "Files" ], "summary": "Download file", "operationId": "GETapi/v1/files/{Id}/download-1.0", "consumes": [], "produces": [ "application/octet-stream" ], "parameters": [ { "name": "Id", "in": "path", "description": "File ID", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "type": "file" } }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/ErrorModel" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "security": [ { "Authorization": [] } ] } }, "/api/v1/files/{Id}/newstates": { "get": { "tags": [ "Files" ], "summary": "Return collection of users with file is new information", "description": "Available for org admin or higher", "operationId": "GETapi/v1/files/{Id}/newstates?Page={Page}&PerPage={PerPage}&SortField={SortField}&SortDirection={SortDirection}-1.0", "consumes": [], "produces": [ "application/json", "text/json", "application/problem+json" ], "parameters": [ { "name": "Id", "in": "path", "description": "File ID", "required": true, "type": "string" }, { "name": "page", "in": "query", "description": "Page number to display", "required": false, "type": "integer", "format": "int32" }, { "name": "perPage", "in": "query", "description": "Items per page in result collection; Default is 25", "required": false, "type": "integer", "format": "int32" }, { "name": "sortField", "in": "query", "description": "Name of field to sort the results by. (username, isnew); Default is username.", "required": false, "type": "string" }, { "name": "sortDirection", "in": "query", "description": "Sort direction; Default is ascending.", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/PagedModelOfFileIsNewForUserModel" } }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/ErrorModel" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "security": [ { "Authorization": [] } ] }, "post": { "tags": [ "Files" ], "summary": "Set file is new for user", "description": "Available for org admin or higher", "operationId": "POSTapi/v1/files/{Id}/newstates-1.0", "consumes": [ "application/json", "text/json", "application/problem+json" ], "produces": [ "application/json", "text/json", "application/problem+json" ], "parameters": [ { "name": "Id", "in": "path", "description": "File ID", "required": true, "type": "string" }, { "name": "body", "in": "body", "description": "Request body", "required": true, "schema": { "$ref": "#/definitions/FileSetIsNewForUserModel" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FileIsNewForUserModel" } }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/ErrorModel" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "security": [ { "Authorization": [] } ] } }, "/api/v1/files": { "get": { "tags": [ "Files" ], "summary": "Get list of files current user can view", "operationId": "GETapi/v1/files?Page={Page}&PerPage={PerPage}&SortField={SortField}&SortDirection={SortDirection}&NewOnly={NewOnly}&SinceDate={SinceDate}-1.0", "consumes": [], "produces": [ "application/json", "text/json", "application/problem+json" ], "parameters": [ { "name": "page", "in": "query", "description": "Page number to display", "required": false, "type": "integer", "format": "int32" }, { "name": "perPage", "in": "query", "description": "Items per page in result collection; Default is 25", "required": false, "type": "integer", "format": "int32" }, { "name": "sortField", "in": "query", "description": "Name of field to sort the results by. (name, size, datetime, uploadstamp or path); Default is Path.", "required": false, "type": "string" }, { "name": "sortDirection", "in": "query", "description": "Sort direction; Default is ascending.", "required": false, "type": "string" }, { "name": "newOnly", "in": "query", "description": "Filter new files", "required": false, "type": "boolean" }, { "name": "sinceDate", "in": "query", "description": "Optional parameter if we want to filter files uploaded from the given date.\r\nDate should not be older than 7 days.", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/SimpleFileResourcePagedModel" } }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/ErrorModel" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "security": [ { "Authorization": [] } ] } }, "/api/v1/files/detailed": { "get": { "tags": [ "Files" ], "summary": "Retrieves a list of files that match the specified wildcard path and file mask criteria.", "operationId": "GETapi/v1/files/detailed?PathMask={PathMask}&FileMask={FileMask}&Recursive={Recursive}&NewOnly={NewOnly}&SortField={SortField}&SortDirection={SortDirection}&SinceDate={SinceDate}-1.0", "consumes": [], "produces": [ "application/json", "text/json", "application/problem+json" ], "parameters": [ { "name": "pathMask", "in": "query", "description": "The path that may contain wildcards to specify the target directory for the search.\r\nFor example, \"home/user/*\" will search in any folder that matches this pattern under \"home/user\".", "required": true, "type": "string" }, { "name": "fileMask", "in": "query", "description": "An optional file mask used to filter the search results, such as \"*.pdf\" for text files.", "required": true, "type": "string" }, { "name": "recursive", "in": "query", "description": "Indicates whether the search should include files in subdirectories (recursive search).", "required": false, "type": "boolean" }, { "name": "newOnly", "in": "query", "description": "Determines whether only files that are new should be included in the results.", "required": false, "type": "boolean" }, { "name": "sortField", "in": "query", "description": "The field by which the search results should be sorted. \r\nAcceptable values include:\r\n- UploadStamp: Sort by the date and time the file was uploaded.\r\n- FileSize: Sort by the size of the file.\r\nIf an unsupported value is provided, the results will be sorted by the file path.", "required": false, "type": "string" }, { "name": "sortDirection", "in": "query", "description": "The order in which to sort the search results, \"asc\" for ascending or \"desc\" for descending.", "required": false, "type": "string" }, { "name": "sinceDate", "in": "query", "description": "The date used to filter results.", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/FileDetailsModel" }, "xml": { "name": "FileDetailsModel", "wrapped": true }, "type": "array" } }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/ErrorModel" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "security": [ { "Authorization": [] } ] } }, "/api/v1/files/{Id}/copy": { "post": { "tags": [ "Files" ], "summary": "Copy file into another folder", "operationId": "POSTapi/v1/files/{Id}/copy-1.0", "consumes": [ "application/json", "text/json", "application/problem+json" ], "produces": [ "application/json", "text/json", "application/problem+json" ], "parameters": [ { "name": "Id", "in": "path", "description": "ID of the file to copy", "required": true, "type": "string" }, { "name": "body", "in": "body", "description": "File copy request details", "required": true, "schema": { "$ref": "#/definitions/FileCopyMoveModel" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FileDetailsModel" } }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/ErrorModel" } }, "404": { "description": "Resource Not Found", "schema": { "$ref": "#/definitions/ErrorModel" } }, "409": { "description": "Operation Conflicted", "schema": { "$ref": "#/definitions/ErrorModel" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "security": [ { "Authorization": [] } ] } }, "/api/v1/files/{Id}/move": { "post": { "tags": [ "Files" ], "summary": "Move file into another folder", "operationId": "POSTapi/v1/files/{Id}/move-1.0", "consumes": [ "application/json", "text/json", "application/problem+json" ], "produces": [ "application/json", "text/json", "application/problem+json" ], "parameters": [ { "name": "Id", "in": "path", "description": "ID of the file to move", "required": true, "type": "string" }, { "name": "body", "in": "body", "description": "File move request details", "required": true, "schema": { "$ref": "#/definitions/FileCopyMoveModel" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FileDetailsModel" } }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/ErrorModel" } }, "404": { "description": "Resource Not Found", "schema": { "$ref": "#/definitions/ErrorModel" } }, "409": { "description": "Operation Conflicted", "schema": { "$ref": "#/definitions/ErrorModel" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "security": [ { "Authorization": [] } ] } }, "/api/v1/files/{Id}/attachments": { "post": { "tags": [ "Files" ], "summary": "Create attachment from existing file", "operationId": "POSTapi/v1/files/{Id}/attachments-1.0", "consumes": [], "produces": [ "application/json", "text/json", "application/problem+json" ], "parameters": [ { "name": "Id", "in": "path", "description": "ID for file existing in MOVEit Transfer", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FileDetailsModel" } }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/ErrorModel" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "security": [ { "Authorization": [] } ] } }, "/api/v1/files/{Id}/newstates/{userId}": { "delete": { "tags": [ "Files" ], "summary": "Set file as not new for user", "description": "Available for org admin or higher", "operationId": "DELETEapi/v1/files/{Id}/newstates/{userId}-1.0", "consumes": [], "produces": [ "application/json", "text/json", "application/problem+json" ], "parameters": [ { "name": "Id", "in": "path", "description": "File ID", "required": true, "type": "string" }, { "name": "userId", "in": "path", "description": "ID for existing user", "required": true, "type": "string" } ], "responses": { "204": { "description": "No Content", "schema": { "$ref": "#/definitions/Void" } }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/ErrorModel" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "security": [ { "Authorization": [] } ] } }, "/api/v1/folders/{folderId}/files/{fileId}": { "get": { "tags": [ "FolderContent" ], "summary": "Get file details in folder. Redirect", "operationId": "GETapi/v1/folders/{folderId}/files/{fileId}-1.0", "consumes": [], "produces": [ "application/json", "text/json", "application/problem+json" ], "parameters": [ { "name": "folderId", "in": "path", "description": "Parent folder ID", "required": true, "type": "integer", "format": "int32" }, { "name": "fileId", "in": "path", "description": "File ID", "required": true, "type": "string" } ], "responses": { "302": { "description": "Redirect" }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/ErrorModel" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "security": [ { "Authorization": [] } ] } }, "/api/v1/folders/{folderId}/files/{fileId}/download": { "get": { "tags": [ "FolderContent" ], "summary": "Download file. Redirect", "description": "The response header includes information about base64-encoded SHA1 digest value returned with file download response", "operationId": "GETapi/v1/folders/{folderId}/files/{fileId}/download-1.0", "consumes": [], "produces": [ "application/json", "text/json", "application/problem+json" ], "parameters": [ { "name": "folderId", "in": "path", "description": "Parent folder ID", "required": true, "type": "integer", "format": "int32" }, { "name": "fileId", "in": "path", "description": "File ID", "required": true, "type": "string" } ], "responses": { "302": { "description": "Redirect" }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/ErrorModel" } }, "422": { "description": "Invalid Request Parameters", "schema": { "$ref": "#/definitions/UnprocessableEntityErrorModel" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "security": [ { "Authorization": [] } ] } }, "/api/v1/folders/{parentId}/subfolders/{subfolderId}": { "get": { "tags": [ "FolderContent" ], "summary": "Get subfolder details. Redirect", "operationId": "GETapi/v1/folders/{parentId}/subfolders/{subfolderId}-1.0", "consumes": [], "produces": [ "application/json", "text/json", "application/problem+json" ], "parameters": [ { "name": "parentId", "in": "path", "description": "Parent folder ID", "required": true, "type": "integer", "format": "int32" }, { "name": "subfolderId", "in": "path", "description": "Folder ID to Get", "required": true, "type": "integer", "format": "int32" } ], "responses": { "302": { "description": "Redirect" }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/ErrorModel" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "security": [ { "Authorization": [] } ] }, "delete": { "tags": [ "FolderContent" ], "summary": "Delete subfolder. Redirect", "operationId": "DELETEapi/v1/folders/{parentId}/subfolders/{subfolderId}-1.0", "consumes": [], "produces": [ "application/json", "text/json", "application/problem+json" ], "parameters": [ { "name": "parentId", "in": "path", "description": "Parent folder ID", "required": true, "type": "integer", "format": "int32" }, { "name": "subfolderId", "in": "path", "description": "Folder ID to Delete", "required": true, "type": "integer", "format": "int32" } ], "responses": { "302": { "description": "Redirect" }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/ErrorModel" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "security": [ { "Authorization": [] } ] } }, "/api/v1/folders/{Id}/subfolders": { "get": { "tags": [ "FolderContent" ], "summary": "Get list of subfolders in folder", "operationId": "GETapi/v1/folders/{Id}/subfolders?Page={Page}&PerPage={PerPage}&SortField={SortField}&SortDirection={SortDirection}&Name={Name}-1.0", "consumes": [], "produces": [ "application/json", "text/json", "application/problem+json" ], "parameters": [ { "name": "Id", "in": "path", "description": "Parent Folder ID", "required": true, "type": "string" }, { "name": "page", "in": "query", "description": "Page number to display", "required": false, "type": "integer", "format": "int32" }, { "name": "perPage", "in": "query", "description": "Items per page in result collection; Default is 25", "required": false, "type": "integer", "format": "int32" }, { "name": "sortField", "in": "query", "description": "Field to sort by; Default is name.", "required": false, "type": "string" }, { "name": "sortDirection", "in": "query", "description": "Sort direction; Default is ascending.", "required": false, "type": "string" }, { "name": "name", "in": "query", "description": "Folder Name mask to search by", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/PagedModelOfSimpleFolderModel" } }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/ErrorModel" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "security": [ { "Authorization": [] } ] }, "post": { "tags": [ "FolderContent" ], "summary": "Create new subfolder in folder", "operationId": "POSTapi/v1/folders/{Id}/subfolders-1.0", "consumes": [ "application/json", "text/json", "application/problem+json" ], "produces": [ "application/json", "text/json", "application/problem+json" ], "parameters": [ { "name": "Id", "in": "path", "description": "ID of the folder where new folder should be added", "required": true, "type": "integer", "format": "int32" }, { "name": "body", "in": "body", "description": "Request body.", "required": true, "schema": { "$ref": "#/definitions/AddFolderModel" } } ], "responses": { "201": { "description": "Created", "schema": { "$ref": "#/definitions/FolderDetailsModel" } }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/ErrorModel" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "security": [ { "Authorization": [] } ] } }, "/api/v1/folders/{Id}/files": { "get": { "tags": [ "FolderContent" ], "summary": "Get list of files in folder", "operationId": "GETapi/v1/folders/{Id}/files?Page={Page}&PerPage={PerPage}&SortField={SortField}&SortDirection={SortDirection}&Name={Name}&NewOnly={NewOnly}-1.0", "consumes": [], "produces": [ "application/json", "text/json", "application/problem+json" ], "parameters": [ { "name": "Id", "in": "path", "description": "Parent Folder ID", "required": true, "type": "string" }, { "name": "page", "in": "query", "description": "Page number to display", "required": false, "type": "integer", "format": "int32" }, { "name": "perPage", "in": "query", "description": "Items per page in result collection; Default is 25", "required": false, "type": "integer", "format": "int32" }, { "name": "sortField", "in": "query", "description": "Field to sort by; Default is name.", "required": false, "type": "string" }, { "name": "sortDirection", "in": "query", "description": "Sort direction; Default is ascending.", "required": false, "type": "string" }, { "name": "name", "in": "query", "description": "File Name mask to search by", "required": false, "type": "string" }, { "name": "newOnly", "in": "query", "description": "Filter new files", "required": false, "type": "boolean" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/PagedModelOfSimpleFileResourceModel" } }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/ErrorModel" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "security": [ { "Authorization": [] } ] }, "post": { "tags": [ "FolderContent" ], "summary": "Upload file into folder", "description": "The content type of the request must be \"multipart/form-data\".\r\nFor large files upload (larger then maxAllowedContentLength attribute in Web.config) use chunked upload.", "operationId": "POSTapi/v1/folders/{Id}/files?UploadType={UploadType}&PathHash={PathHash}-1.0", "consumes": [ "multipart/form-data" ], "produces": [ "application/json", "text/json", "application/problem+json" ], "parameters": [ { "name": "Id", "in": "path", "description": "Folder ID", "required": true, "type": "string" }, { "name": "hashtype", "in": "formData", "description": "Type of hash provided (sha-1, sha-256, sha-384, sha-512)", "required": false, "type": "string" }, { "name": "hash", "in": "formData", "description": "Hash of file", "required": false, "type": "string" }, { "name": "file", "in": "formData", "description": "File contents", "required": true, "type": "file" }, { "name": "comments", "in": "formData", "description": "File upload comments", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ResumableFileUploadModel" } }, "201": { "description": "Created", "schema": { "$ref": "#/definitions/FileDetailsModel" } }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/ErrorModel" } }, "422": { "description": "Invalid Request Parameters", "schema": { "$ref": "#/definitions/UnprocessableEntityErrorModel" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "security": [ { "Authorization": [] } ] } }, "/api/v1/folders/{Id}/content": { "get": { "tags": [ "FolderContent" ], "summary": "Get content of the folder", "operationId": "GETapi/v1/folders/{Id}/content?PathHash={PathHash}&Page={Page}&PerPage={PerPage}&SortField={SortField}&SortDirection={SortDirection}&Name={Name}-1.0", "consumes": [], "produces": [ "application/json", "text/json", "application/problem+json" ], "parameters": [ { "name": "Id", "in": "path", "description": "Parent Folder ID", "required": true, "type": "string" }, { "name": "pathHash", "in": "query", "description": "Parent Folder path hash", "required": false, "type": "string" }, { "name": "page", "in": "query", "description": "Page number to display", "required": false, "type": "integer", "format": "int32" }, { "name": "perPage", "in": "query", "description": "Items per page in result collection; Default is 25", "required": false, "type": "integer", "format": "int32" }, { "name": "sortField", "in": "query", "description": "Field to sort by; (type, time, size or name); Sorting order starts with type and ends with name", "required": false, "type": "string" }, { "name": "sortDirection", "in": "query", "description": "Sort direction; Default is ascending.", "required": false, "type": "string" }, { "name": "name", "in": "query", "description": "Name mask to search by", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/PagedModelOfFolderContentItemModel" } }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/ErrorModel" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "security": [ { "Authorization": [] } ] } }, "/api/v1/folders": { "get": { "tags": [ "Folders" ], "summary": "Get list of folders current user can view", "operationId": "GETapi/v1/folders-1.0", "consumes": [], "produces": [ "application/json", "text/json", "application/problem+json" ], "parameters": [ { "name": "name", "in": "query", "description": "File name mask for filtering list of Folders", "required": false, "type": "string" }, { "name": "path", "in": "query", "description": "File path mask for filtering list of Folders", "required": false, "type": "string" }, { "name": "page", "in": "query", "description": "Page number to display", "required": false, "type": "integer", "format": "int32" }, { "name": "perPage", "in": "query", "description": "Items per page in result collection; Default is 25", "required": false, "type": "integer", "format": "int32" }, { "name": "sortField", "in": "query", "description": "Name of field to sort the results by. (Name, Type or Path); Default is Path.", "required": false, "type": "string" }, { "name": "sortDirection", "in": "query", "description": "Sort direction; Default is ascending.", "required": false, "type": "string" }, { "name": "sharedTo", "in": "query", "required": false, "items": { "type": "string" }, "collectionFormat": "multi", "type": "array" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/PagedModelOfSimpleFolderModel" } }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/ErrorModel" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "security": [ { "Authorization": [] } ] } }, "/api/v1/folders/{Id}": { "get": { "tags": [ "Folders" ], "summary": "Return folder details", "operationId": "GETapi/v1/folders/{Id}?SkipCounts={SkipCounts}&SkipFilesSize={SkipFilesSize}&PathHash={PathHash}-1.0", "consumes": [], "produces": [ "application/json", "text/json", "application/problem+json" ], "parameters": [ { "name": "Id", "in": "path", "description": "Folder ID", "required": true, "type": "string" }, { "name": "skipCounts", "in": "query", "description": "Whether to skip including counts of various folder properties like files\r\nand subfolders in the folder details results.", "required": false, "type": "boolean" }, { "name": "skipFilesSize", "in": "query", "description": "Whether to skip including total files size in a directory and its subdirectories(if any).", "required": false, "type": "boolean" }, { "name": "pathHash", "in": "query", "description": "File path hash for getting proper folder relations", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FolderDetailsModel" } }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/ErrorModel" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "security": [ { "Authorization": [] } ] }, "delete": { "tags": [ "Folders" ], "summary": "Delete folder", "operationId": "DELETEapi/v1/folders/{Id}?PathHash={PathHash}-1.0", "consumes": [], "produces": [ "application/json", "text/json", "application/problem+json" ], "parameters": [ { "name": "Id", "in": "path", "description": "Folder ID", "required": true, "type": "string" }, { "name": "pathHash", "in": "query", "description": "File path hash for getting proper folder relations", "required": false, "type": "string" } ], "responses": { "204": { "description": "No Content", "schema": { "$ref": "#/definitions/Void" } }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/ErrorModel" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "security": [ { "Authorization": [] } ] }, "patch": { "tags": [ "Folders" ], "summary": "Partial Folder update", "operationId": "PATCHapi/v1/folders/{Id}-1.0", "consumes": [ "application/json", "text/json", "application/problem+json" ], "produces": [ "application/json", "text/json", "application/problem+json" ], "parameters": [ { "name": "Id", "in": "path", "description": "ID of the folder to update", "required": true, "type": "integer", "format": "int32" }, { "name": "body", "in": "body", "description": "Request body.", "required": true, "schema": { "$ref": "#/definitions/FolderPatchModel" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FolderDetailsModel" } }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/ErrorModel" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "security": [ { "Authorization": [] } ] } }, "/api/v1/folders/{Id}/acls": { "get": { "tags": [ "Folders" ], "summary": "Lists the Access Controls for a given folder", "operationId": "GETapi/v1/folders/{Id}/acls?Page={Page}&PerPage={PerPage}&SortField={SortField}&SortDirection={SortDirection}&PathHash={PathHash}-1.0", "consumes": [], "produces": [ "application/json", "text/json", "application/problem+json" ], "parameters": [ { "name": "Id", "in": "path", "description": "Folder ID", "required": true, "type": "string" }, { "name": "page", "in": "query", "description": "Page number to display", "required": false, "type": "integer", "format": "int32" }, { "name": "perPage", "in": "query", "description": "Items per page in result collection; Default is 25", "required": false, "type": "integer", "format": "int32" }, { "name": "sortField", "in": "query", "description": "Field to sort by; Default is name.", "required": false, "type": "string" }, { "name": "sortDirection", "in": "query", "description": "Sort direction; Default is ascending.", "required": false, "type": "string" }, { "name": "pathHash", "in": "query", "description": "File path hash for getting proper folder relations", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/PagedModelOfFolderAclEntryResourceModel" } }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/ErrorModel" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "Folders" ], "summary": "Change the Access Controls for a given folder", "operationId": "PUTapi/v1/folders/{Id}/acls-1.0", "consumes": [ "application/json", "text/json", "application/problem+json" ], "produces": [ "application/json", "text/json", "application/problem+json" ], "parameters": [ { "name": "Id", "in": "path", "description": "ID of the folder to change access control", "required": true, "type": "integer", "format": "int32" }, { "name": "body", "in": "body", "description": "Access control", "required": true, "schema": { "$ref": "#/definitions/PutFolderAclEntryRequestModel" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/PagedModelOfFolderAclEntryResourceModel" } }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/ErrorModel" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "security": [ { "Authorization": [] } ] }, "post": { "tags": [ "Folders" ], "summary": "Set the Access Controls for a given folder", "operationId": "POSTapi/v1/folders/{Id}/acls-1.0", "consumes": [ "application/json", "text/json", "application/problem+json" ], "produces": [ "application/json", "text/json", "application/problem+json" ], "parameters": [ { "name": "Id", "in": "path", "description": "ID of the folder to set access control", "required": true, "type": "integer", "format": "int32" }, { "name": "body", "in": "body", "description": "Access control", "required": true, "schema": { "$ref": "#/definitions/SetFolderAclEntryRequestModel" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/PagedModelOfFolderAclEntryResourceModel" } }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/ErrorModel" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "security": [ { "Authorization": [] } ] }, "delete": { "tags": [ "Folders" ], "summary": "Delete the Access Controls for a given folder", "operationId": "DELETEapi/v1/folders/{Id}/acls-1.0", "consumes": [ "application/json", "text/json", "application/problem+json" ], "produces": [ "application/json", "text/json", "application/problem+json" ], "parameters": [ { "name": "Id", "in": "path", "description": "ID of the folder to delete access control", "required": true, "type": "integer", "format": "int32" }, { "name": "body", "in": "body", "description": "Entity type and ID", "required": true, "schema": { "$ref": "#/definitions/DeleteFolderAclEntryRequestModel" } } ], "responses": { "204": { "description": "No Content", "schema": { "$ref": "#/definitions/Void" } }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/ErrorModel" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "security": [ { "Authorization": [] } ] } }, "/api/v1/folders/{Id}/copy": { "post": { "tags": [ "Folders" ], "summary": "Copy folder into another folder", "operationId": "POSTapi/v1/folders/{Id}/copy-1.0", "consumes": [ "application/json", "text/json", "application/problem+json" ], "produces": [ "application/json", "text/json", "application/problem+json" ], "parameters": [ { "name": "Id", "in": "path", "description": "ID of the folder to copy", "required": true, "type": "integer", "format": "int32" }, { "name": "body", "in": "body", "description": "Folder copy request details", "required": true, "schema": { "$ref": "#/definitions/FolderCopyMoveModel" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FolderDetailsModel" } }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/ErrorModel" } }, "404": { "description": "Resource Not Found", "schema": { "$ref": "#/definitions/ErrorModel" } }, "409": { "description": "Operation Conflicted", "schema": { "$ref": "#/definitions/ErrorModel" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "security": [ { "Authorization": [] } ] } }, "/api/v1/folders/{Id}/move": { "post": { "tags": [ "Folders" ], "summary": "Move folder into another folder", "operationId": "POSTapi/v1/folders/{Id}/move-1.0", "consumes": [ "application/json", "text/json", "application/problem+json" ], "produces": [ "application/json", "text/json", "application/problem+json" ], "parameters": [ { "name": "Id", "in": "path", "description": "ID of the folder to move", "required": true, "type": "integer", "format": "int32" }, { "name": "body", "in": "body", "description": "Folder move request details", "required": true, "schema": { "$ref": "#/definitions/FolderCopyMoveModel" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FolderDetailsModel" } }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/ErrorModel" } }, "404": { "description": "Resource Not Found", "schema": { "$ref": "#/definitions/ErrorModel" } }, "409": { "description": "Operation Conflicted", "schema": { "$ref": "#/definitions/ErrorModel" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "security": [ { "Authorization": [] } ] } }, "/api/v1/folders/{Id}/filemasks": { "patch": { "tags": [ "Folders" ], "summary": "Change Allowed File Masks", "operationId": "PATCHapi/v1/folders/{Id}/filemasks-1.0", "consumes": [ "application/json", "text/json", "application/problem+json" ], "produces": [ "application/json", "text/json", "application/problem+json" ], "parameters": [ { "name": "Id", "in": "path", "description": "ID of the folder", "required": true, "type": "integer", "format": "int32" }, { "name": "body", "in": "body", "description": "Folder update filemasks settings", "required": true, "schema": { "$ref": "#/definitions/UpdateFolderFileMasksSettingsModel" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FolderFileMasksSettingsModel" } }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/ErrorModel" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "security": [ { "Authorization": [] } ] } }, "/api/v1/folders/{Id}/maintenance": { "patch": { "tags": [ "Folders" ], "summary": "Change Automated Maintenance Settings", "operationId": "PATCHapi/v1/folders/{Id}/maintenance-1.0", "consumes": [ "application/json", "text/json", "application/problem+json" ], "produces": [ "application/json", "text/json", "application/problem+json" ], "parameters": [ { "name": "Id", "in": "path", "description": "ID of the folder", "required": true, "type": "integer", "format": "int32" }, { "name": "body", "in": "body", "description": "Folder update maintenance settings", "required": true, "schema": { "$ref": "#/definitions/UpdateFolderMaintenanceSettingsModel" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FolderMaintenanceSettingsModel" } }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/ErrorModel" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "security": [ { "Authorization": [] } ] } }, "/api/v1/folders/{Id}/miscellaneous": { "patch": { "tags": [ "Folders" ], "summary": "Change Miscellaneous Settings", "operationId": "PATCHapi/v1/folders/{Id}/miscellaneous-1.0", "consumes": [ "application/json", "text/json", "application/problem+json" ], "produces": [ "application/json", "text/json", "application/problem+json" ], "parameters": [ { "name": "Id", "in": "path", "description": "ID of the folder", "required": true, "type": "integer", "format": "int32" }, { "name": "body", "in": "body", "description": "Folder update miscellaneous settings", "required": true, "schema": { "$ref": "#/definitions/UpdateFolderMiscellaneousSettingsModel" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FolderMaintenanceSettingsModel" } }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/ErrorModel" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "security": [ { "Authorization": [] } ] } }, "/api/v1/folders/{Id}/notifications": { "patch": { "tags": [ "Folders" ], "summary": "Change folder update notifications", "operationId": "PATCHapi/v1/folders/{Id}/notifications-1.0", "consumes": [ "application/json", "text/json", "application/problem+json" ], "produces": [ "application/json", "text/json", "application/problem+json" ], "parameters": [ { "name": "Id", "in": "path", "description": "ID of the folder to change folder update notification settings", "required": true, "type": "integer", "format": "int32" }, { "name": "body", "in": "body", "description": "Folder update notification settings", "required": true, "schema": { "$ref": "#/definitions/UpdateFolderNotificationSettingsModel" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FolderNotificationSettingsModel" } }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/ErrorModel" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "security": [ { "Authorization": [] } ] } }, "/api/v1/folders/{Id}/acls/{entryId}": { "patch": { "tags": [ "Folders" ], "summary": "Change the single user Access Controls for a given folder", "operationId": "PATCHapi/v1/folders/{Id}/acls/{entryId}-1.0", "consumes": [ "application/json", "text/json", "application/problem+json" ], "produces": [ "application/json", "text/json", "application/problem+json" ], "parameters": [ { "name": "Id", "in": "path", "description": "ID of the folder to set access control", "required": true, "type": "integer", "format": "int32" }, { "name": "entryId", "in": "path", "description": "ID of the access control to change. The format of this entryId is type!id, where type can be user or group, and id is the user or group id.", "required": true, "type": "string" }, { "name": "body", "in": "body", "description": "Access control", "required": true, "schema": { "$ref": "#/definitions/UpdateFolderAclEntryRequestModel" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FolderAclEntryResourceModel" } }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/ErrorModel" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "security": [ { "Authorization": [] } ] } }, "/api/v1/folders/{Id}/characterRestrictions": { "patch": { "tags": [ "Folders" ], "summary": "Change file and folder name character restrictions", "operationId": "PATCHapi/v1/folders/{Id}/characterRestrictions-1.0", "consumes": [ "application/json", "text/json", "application/problem+json" ], "produces": [ "application/json", "text/json", "application/problem+json" ], "parameters": [ { "name": "Id", "in": "path", "description": "ID of the folder to change character restrictions", "required": true, "type": "integer", "format": "int32" }, { "name": "body", "in": "body", "description": "Folder character restrictions", "required": true, "schema": { "$ref": "#/definitions/UpdateFolderCharacterRestrictionsModel" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FolderCharacterRestrictionsModel" } }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/ErrorModel" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "security": [ { "Authorization": [] } ] } }, "/api/v1/groups": { "get": { "tags": [ "Groups" ], "summary": "Get list of groups current user can view", "operationId": "GETapi/v1/groups?Page={Page}&PerPage={PerPage}-1.0", "consumes": [], "produces": [ "application/json", "text/json", "application/problem+json" ], "parameters": [ { "name": "page", "in": "query", "description": "Page number to display", "required": false, "type": "integer", "format": "int32" }, { "name": "perPage", "in": "query", "description": "Items per page in result collection; Default is 25", "required": false, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/PagedModelOfGroupModel" } }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/ErrorModel" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "security": [ { "Authorization": [] } ] }, "post": { "tags": [ "Groups" ], "summary": "Create new group", "operationId": "POSTapi/v1/groups-1.0", "consumes": [ "application/json", "text/json", "application/problem+json" ], "produces": [ "application/json", "text/json", "application/problem+json" ], "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/BaseGroupModel" } } ], "responses": { "201": { "description": "Created", "schema": { "$ref": "#/definitions/GroupModel" } }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/ErrorModel" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "security": [ { "Authorization": [] } ] } }, "/api/v1/groups/{Id}/members": { "get": { "tags": [ "Groups" ], "summary": "Get a list of the members of a group", "operationId": "GETapi/v1/groups/{Id}/members?Page={Page}&PerPage={PerPage}-1.0", "consumes": [], "produces": [ "application/json", "text/json", "application/problem+json" ], "parameters": [ { "name": "Id", "in": "path", "description": "Group ID", "required": true, "type": "string" }, { "name": "page", "in": "query", "description": "Page number to display", "required": false, "type": "integer", "format": "int32" }, { "name": "perPage", "in": "query", "description": "Items per page in result collection; Default is 25", "required": false, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/PagedModelOfSimpleUserModel" } }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/ErrorModel" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "security": [ { "Authorization": [] } ] }, "post": { "tags": [ "Groups" ], "summary": "Add members(s) to group", "operationId": "POSTapi/v1/groups/{Id}/members-1.0", "consumes": [ "application/json", "text/json", "application/problem+json" ], "produces": [ "application/json", "text/json", "application/problem+json" ], "parameters": [ { "name": "Id", "in": "path", "required": true, "type": "string" }, { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/GroupAddMemberRequest" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/PagedModelOfSimpleUserModel" } }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/ErrorModel" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "security": [ { "Authorization": [] } ] } }, "/api/v1/groups/{Id}/members/{UserId}": { "delete": { "tags": [ "Groups" ], "summary": "Remove member from group", "operationId": "DELETEapi/v1/groups/{Id}/members/{UserId}-1.0", "consumes": [], "produces": [ "application/json", "text/json", "application/problem+json" ], "parameters": [ { "name": "Id", "in": "path", "description": "Group ID", "required": true, "type": "string" }, { "name": "UserId", "in": "path", "description": "User ID", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/PagedModelOfSimpleUserModel" } }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/ErrorModel" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "security": [ { "Authorization": [] } ] } }, "/api/v1/logs/{Id}": { "get": { "tags": [ "Logs" ], "summary": "Get log's info", "operationId": "GETapi/v1/logs/{Id}-1.0", "consumes": [], "produces": [ "application/json", "text/json", "application/problem+json" ], "parameters": [ { "name": "Id", "in": "path", "description": "Log ID", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/LogDetailsModel" } }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/ErrorModel" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "security": [ { "Authorization": [] } ] } }, "/api/v1/logs": { "get": { "tags": [ "Logs" ], "summary": "Get list of logs current user can view", "operationId": "GETapi/v1/logs?Page={Page}&PerPage={PerPage}&SortField={SortField}&SortDirection={SortDirection}&StartDateTime={StartDateTime}&EndDateTime={EndDateTime}&Action={Action}&UserNameContains={UserNameContains}&UserId={UserId}&FileIdContains={FileIdContains}&FileNameContains={FileNameContains}&SizeComparison={SizeComparison}&Size={Size}&FolderId={FolderId}&FolderPathContains={FolderPathContains}&IpContains={IpContains}&AgentBrandContains={AgentBrandContains}&SuccessFailure={SuccessFailure}&SuppressSigns={SuppressSigns}&SuppressEmailNotes={SuppressEmailNotes}&SuppressLogViews={SuppressLogViews}-1.0", "consumes": [], "produces": [ "application/json", "text/json", "application/problem+json" ], "parameters": [ { "name": "page", "in": "query", "description": "Page number to display", "required": false, "type": "integer", "format": "int32" }, { "name": "perPage", "in": "query", "description": "Items per page in result collection; Default is 25", "required": false, "type": "integer", "format": "int32" }, { "name": "sortField", "in": "query", "description": "Name of field to sort the results by. (logtime, action, username, userrealname, targetname, filename, fileid, folderpath, xfersize, duration, rate, ipaddress, agentbrand, resilnode); Default is logtime.", "required": false, "type": "string" }, { "name": "sortDirection", "in": "query", "description": "Sort direction; Default is ascending.", "required": false, "type": "string" }, { "name": "startDateTime", "in": "query", "description": "Start Date/Time (MM-dd-yy, MM-dd-yyyy, MM-dd-yyyy HH:mm:ss, MM/dd/yyyy, MM/dd/yyyy HH:mm etc.)", "required": false, "type": "string" }, { "name": "endDateTime", "in": "query", "description": "End Date/Time (MM-dd-yy, MM-dd-yyyy, MM-dd-yyyy HH:mm:ss, MM/dd/yyyy, MM/dd/yyyy HH:mm etc.)", "required": false, "type": "string" }, { "name": "action", "in": "query", "description": "Name of action to filter by", "required": false, "type": "string", "default": 0, "enum": [ "None", "FileTransfer", "Administration", "Upload", "Download", "UserMaintenance", "ContentScanning" ] }, { "name": "userNameContains", "in": "query", "description": "Show usernames like this (For admin users only)", "required": false, "type": "string" }, { "name": "userId", "in": "query", "description": "Show only this user id (For admin users only. For non admin users current user ID is used.)", "required": false, "type": "string" }, { "name": "fileIdContains", "in": "query", "description": "Show file IDs like this", "required": false, "type": "string" }, { "name": "fileNameContains", "in": "query", "description": "Show file names like this", "required": false, "type": "string" }, { "name": "sizeComparison", "in": "query", "description": "File size comparison selection", "required": false, "type": "string", "default": 0, "enum": [ "None", "LargerOrEqual", "SmallerOrEqual" ] }, { "name": "size", "in": "query", "description": "File size (in KB)", "required": false, "type": "string" }, { "name": "folderId", "in": "query", "description": "Show only this Folder id", "required": false, "type": "string" }, { "name": "folderPathContains", "in": "query", "description": "Show folder path like this", "required": false, "type": "string" }, { "name": "ipContains", "in": "query", "description": "Show IP address like this", "required": false, "type": "string" }, { "name": "agentBrandContains", "in": "query", "description": "Show Agent Brand like this", "required": false, "type": "string" }, { "name": "successFailure", "in": "query", "description": "Filter Success/Errors", "required": false, "type": "string", "default": 0, "enum": [ "None", "Success", "Error" ] }, { "name": "suppressSigns", "in": "query", "description": "Suppress sign on/ sign off. Default is true", "required": false, "type": "boolean" }, { "name": "suppressEmailNotes", "in": "query", "description": "Suppress email notes. Default is true", "required": false, "type": "boolean" }, { "name": "suppressLogViews", "in": "query", "description": "Suppress log views. Default is true", "required": false, "type": "boolean" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/PagedModelOfSimpleLogModel" } }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/ErrorModel" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "security": [ { "Authorization": [] } ] } }, "/api/v1/mailboxes": { "get": { "tags": [ "Mailboxes" ], "summary": "Retrieve mailboxes list", "operationId": "GETapi/v1/mailboxes-1.0", "consumes": [], "produces": [ "application/json", "text/json", "application/problem+json" ], "parameters": [], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/MailboxModel" }, "xml": { "name": "MailboxModel", "wrapped": true }, "type": "array" } }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/ErrorModel" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "security": [ { "Authorization": [] } ] } }, "/api/v1/mailboxes/{Id}": { "get": { "tags": [ "Mailboxes" ], "summary": "Retrieve mailbox info", "operationId": "GETapi/v1/mailboxes/{Id}-1.0", "consumes": [], "produces": [ "application/json", "text/json", "application/problem+json" ], "parameters": [ { "name": "Id", "in": "path", "description": "ID of the mailbox", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/MailboxModel" } }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/ErrorModel" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "security": [ { "Authorization": [] } ] } }, "/api/v1/mailboxes/{Id}/packages": { "get": { "tags": [ "Mailboxes" ], "summary": "Retrieve mailbox content", "operationId": "GETapi/v1/mailboxes/{Id}/packages-1.0", "consumes": [], "produces": [ "application/json", "text/json", "application/problem+json" ], "parameters": [ { "name": "Id", "in": "path", "description": "ID of the mailbox", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/SimplePackageModel" }, "xml": { "name": "SimplePackageModel", "wrapped": true }, "type": "array" } }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/ErrorModel" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "security": [ { "Authorization": [] } ] }, "post": { "tags": [ "Mailboxes" ], "summary": "Move package", "operationId": "POSTapi/v1/mailboxes/{Id}/packages-1.0", "consumes": [ "application/json", "text/json", "application/problem+json" ], "produces": [ "application/json", "text/json", "application/problem+json" ], "parameters": [ { "name": "Id", "in": "path", "description": "ID of the destination mailbox", "required": true, "type": "string" }, { "name": "body", "in": "body", "description": "Request body.", "required": true, "schema": { "$ref": "#/definitions/PackageMovePatchModel" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/PackageDetailsModel" } }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/ErrorModel" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "security": [ { "Authorization": [] } ] } }, "/api/v1/mailboxes/{Id}/packages/{PackageId}": { "get": { "tags": [ "Mailboxes" ], "summary": "Get package info", "operationId": "GETapi/v1/mailboxes/{Id}/packages/{PackageId}?Action={Action}-1.0", "consumes": [], "produces": [ "application/json", "text/json", "application/problem+json" ], "parameters": [ { "name": "Id", "in": "path", "description": "Mailbox id", "required": true, "type": "string" }, { "name": "packageId", "in": "query", "description": "Package id", "required": true, "type": "string" }, { "name": "action", "in": "query", "description": "Package action (Reply, ReplyAll, Forward, Resend)", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/PackageDetailsModel" } }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/ErrorModel" } }, "404": { "description": "Resource Not Found", "schema": { "$ref": "#/definitions/ErrorModel" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "security": [ { "Authorization": [] } ] } }, "/api/v1/mailboxes/{Id}/packages/{packageId}": { "delete": { "tags": [ "Mailboxes" ], "summary": "Remove package from user's mailbox", "operationId": "DELETEapi/v1/mailboxes/{Id}/packages/{packageId}-1.0", "consumes": [], "produces": [ "application/json", "text/json", "application/problem+json" ], "parameters": [ { "name": "Id", "in": "path", "description": "ID of the mailbox", "required": true, "type": "string" }, { "name": "packageId", "in": "path", "description": "ID of the package to delete", "required": true, "type": "string" } ], "responses": { "204": { "description": "No Content", "schema": { "$ref": "#/definitions/Void" } }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/ErrorModel" } }, "404": { "description": "Resource Not Found", "schema": { "$ref": "#/definitions/ErrorModel" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "security": [ { "Authorization": [] } ] }, "patch": { "tags": [ "Mailboxes" ], "summary": "Partial package update", "operationId": "PATCHapi/v1/mailboxes/{Id}/packages/{packageId}-1.0", "consumes": [ "application/json", "text/json", "application/problem+json" ], "produces": [ "application/json", "text/json", "application/problem+json" ], "parameters": [ { "name": "Id", "in": "path", "description": "ID of the mailbox", "required": true, "type": "string" }, { "name": "packageId", "in": "path", "description": "ID of the package to update", "required": true, "type": "string" }, { "name": "body", "in": "body", "description": "Request body.", "required": true, "schema": { "$ref": "#/definitions/PackagePatchModel" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/SimplePackageModel" } }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/ErrorModel" } }, "404": { "description": "Resource Not Found", "schema": { "$ref": "#/definitions/ErrorModel" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "security": [ { "Authorization": [] } ] } }, "/api/v1/mailboxes/trash": { "delete": { "tags": [ "Mailboxes" ], "summary": "Empty trash", "operationId": "DELETEapi/v1/mailboxes/trash-1.0", "consumes": [], "produces": [ "application/json", "text/json", "application/problem+json" ], "responses": { "204": { "description": "No Content", "schema": { "$ref": "#/definitions/Void" } }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/ErrorModel" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "security": [ { "Authorization": [] } ] } }, "/api/v1/settings/miscellaneous/aging/logs": { "post": { "tags": [ "MiscellaneousSettings" ], "summary": "Update audit logs settings.", "operationId": "POSTapi/v1/settings/miscellaneous/aging/logs-1.0", "consumes": [ "application/json", "text/json", "application/problem+json" ], "produces": [ "application/json", "text/json", "application/problem+json" ], "parameters": [ { "name": "request", "in": "body", "required": true, "schema": { "$ref": "#/definitions/LogsSettingsUpdateRequest" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/LogsSettingsModel" } } }, "security": [ { "Authorization": [] } ] } }, "/api/v1/organizations/{OrgId}": { "get": { "tags": [ "Organizations" ], "summary": "Gets detailed information about organization", "operationId": "GETapi/v1/organizations/{OrgId}-1.0", "consumes": [], "produces": [ "application/json", "text/json", "application/problem+json" ], "parameters": [ { "name": "OrgId", "in": "path", "description": "The Id of the target Org for this request", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OrgDetailedModel" } } }, "security": [ { "Authorization": [] } ] } }, "/api/v1/organizations": { "get": { "tags": [ "Organizations" ], "summary": "Get list of organizations", "operationId": "GETapi/v1/organizations?Page={Page}&PerPage={PerPage}&SortField={SortField}&SortDirection={SortDirection}-1.0", "consumes": [], "produces": [ "application/json", "text/json", "application/problem+json" ], "parameters": [ { "name": "page", "in": "query", "description": "Page number to display", "required": false, "type": "integer", "format": "int32" }, { "name": "perPage", "in": "query", "description": "Items per page in result collection; Default is 25", "required": false, "type": "integer", "format": "int32" }, { "name": "sortField", "in": "query", "description": "Name of field to sort the results by. (name, id); Default is Name.", "required": false, "type": "string" }, { "name": "sortDirection", "in": "query", "description": "Sort direction; Default is ascending.", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/PagedModelOfSimpleOrgModel" } } }, "security": [ { "Authorization": [] } ] }, "post": { "tags": [ "Organizations" ], "summary": "Create new organization", "operationId": "POSTapi/v1/organizations-1.0", "consumes": [ "application/json", "text/json", "application/problem+json" ], "produces": [ "application/json", "text/json", "application/problem+json" ], "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OrgAddModel" } } ], "responses": { "201": { "description": "Created", "schema": { "$ref": "#/definitions/OrgDetailedModel" } } }, "security": [ { "Authorization": [] } ] } }, "/api/v1/organizations/{orgId}/maxusercounts": { "post": { "tags": [ "Organizations" ], "summary": "Update maximum user counts for the organization", "operationId": "POSTapi/v1/organizations/{orgId}/maxusercounts-1.0", "consumes": [ "application/json", "text/json", "application/problem+json" ], "produces": [ "application/json", "text/json", "application/problem+json" ], "parameters": [ { "name": "orgId", "in": "path", "description": "Organization id", "required": true, "type": "integer", "format": "int32" }, { "name": "body", "in": "body", "description": "Represents maximum user counts for an organization.", "required": true, "schema": { "$ref": "#/definitions/OrgMaxUserCountsModel" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OrgMaxUserCountsModel" } } }, "security": [ { "Authorization": [] } ] } }, "/api/v1/organizations/{orgId}/packageaccess": { "post": { "tags": [ "Organizations" ], "summary": "Update administrator package access for the organization", "operationId": "POSTapi/v1/organizations/{orgId}/packageaccess-1.0", "consumes": [ "application/json", "text/json", "application/problem+json" ], "produces": [ "application/json", "text/json", "application/problem+json" ], "parameters": [ { "name": "orgId", "in": "path", "description": "Organization id", "required": true, "type": "integer", "format": "int32" }, { "name": "body", "in": "body", "description": "Represents administrator package access settings update model for an organization.", "required": true, "schema": { "$ref": "#/definitions/OrgPackageAccessUpdateModel" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OrgPackageAccessModel" } } }, "security": [ { "Authorization": [] } ] } }, "/api/v1/organizations/{orgId}/passwordreset": { "post": { "tags": [ "Organizations" ], "summary": "Update administrators password reset settings for the organization", "operationId": "POSTapi/v1/organizations/{orgId}/passwordreset-1.0", "consumes": [ "application/json", "text/json", "application/problem+json" ], "produces": [ "application/json", "text/json", "application/problem+json" ], "parameters": [ { "name": "orgId", "in": "path", "description": "Organization id", "required": true, "type": "integer", "format": "int32" }, { "name": "body", "in": "body", "description": "Represents administrator password reset settings for an organization.", "required": true, "schema": { "$ref": "#/definitions/OrgAdminPasswordResetSettingsModel" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OrgAdminPasswordResetSettingsModel" } } }, "security": [ { "Authorization": [] } ] } }, "/api/v1/organizations/{orgId}/interfaceconfiguration": { "post": { "tags": [ "Organizations" ], "summary": "Update user interface configuration for the organization", "operationId": "POSTapi/v1/organizations/{orgId}/interfaceconfiguration-1.0", "consumes": [ "application/json", "text/json", "application/problem+json" ], "produces": [ "application/json", "text/json", "application/problem+json" ], "parameters": [ { "name": "orgId", "in": "path", "description": "Organization id", "required": true, "type": "integer", "format": "int32" }, { "name": "body", "in": "body", "description": "Represents user interface configuration", "required": true, "schema": { "$ref": "#/definitions/OrgUiConfigurationModel" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OrgUiConfigurationModel" } } }, "security": [ { "Authorization": [] } ] } }, "/api/v1/organizations/{orgId}": { "patch": { "tags": [ "Organizations" ], "summary": "Edit general organization information", "operationId": "PATCHapi/v1/organizations/{orgId}-1.0", "consumes": [ "application/json", "text/json", "application/problem+json" ], "produces": [ "application/json", "text/json", "application/problem+json" ], "parameters": [ { "name": "orgId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OrgPatchModel" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OrgDetailedModel" } } }, "security": [ { "Authorization": [] } ] } }, "/api/v1/packages": { "get": { "tags": [ "Packages" ], "summary": "Get all packages current user can view", "operationId": "GETapi/v1/packages-1.0", "consumes": [], "produces": [ "application/json", "text/json", "application/problem+json" ], "parameters": [ { "name": "page", "in": "query", "description": "Page number to display", "required": false, "type": "integer", "format": "int32" }, { "name": "perPage", "in": "query", "description": "Items per page in result collection; Default is 25", "required": false, "type": "integer", "format": "int32" }, { "name": "sortField", "in": "query", "description": "Name of field to sort the results by. (sendStamp); Default is sendStamp.", "required": false, "type": "string" }, { "name": "sortDirection", "in": "query", "description": "Sort direction; Default is ascending.", "required": false, "type": "string" }, { "name": "newOnly", "in": "query", "description": "Filter new files", "required": false, "type": "boolean" }, { "name": "sentTo", "in": "query", "description": "Filter by recipients", "required": false, "items": { "type": "string" }, "collectionFormat": "multi", "type": "array" }, { "name": "receivedFrom", "in": "query", "description": "Filter by senders", "required": false, "items": { "type": "string" }, "collectionFormat": "multi", "type": "array" }, { "name": "mailboxId", "in": "query", "description": "Filter by mailbox ID", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/PagedModelOfSimplePackageModel" } }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/ErrorModel" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "security": [ { "Authorization": [] } ] }, "post": { "tags": [ "Packages" ], "summary": "Save or send package", "operationId": "POSTapi/v1/packages-1.0", "consumes": [ "application/json", "text/json", "application/problem+json" ], "produces": [ "application/json", "text/json", "application/problem+json" ], "parameters": [ { "name": "body", "in": "body", "description": "Request body.", "required": true, "schema": { "$ref": "#/definitions/CreatePackageRequestModel" } } ], "responses": { "201": { "description": "Created", "schema": { "$ref": "#/definitions/PackageDetailsModel" } }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/ErrorModel" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "security": [ { "Authorization": [] } ] } }, "/api/v1/packages/requirements": { "get": { "tags": [ "Packages" ], "summary": "Get package requirements", "operationId": "GETapi/v1/packages/requirements-1.0", "consumes": [], "produces": [ "application/json", "text/json", "application/problem+json" ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/PackageRequirementsModel" } }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/ErrorModel" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "security": [ { "Authorization": [] } ] } }, "/api/v1/packages/{Id}/recipients": { "get": { "tags": [ "Packages" ], "summary": "Get package recipient info", "operationId": "GETapi/v1/packages/{Id}/recipients?MailboxId={MailboxId}-1.0", "consumes": [], "produces": [ "application/json", "text/json", "application/problem+json" ], "parameters": [ { "name": "Id", "in": "path", "description": "Package id", "required": true, "type": "string" }, { "name": "mailboxId", "in": "query", "description": "Mailbox id", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/CollectionModelOfRecipientListItem" } }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/ErrorModel" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "security": [ { "Authorization": [] } ] } }, "/api/v1/packages/{Id}": { "get": { "tags": [ "Packages" ], "summary": "Get package info", "operationId": "GETapi/v1/packages/{Id}?Action={Action}&MailboxId={MailboxId}-1.0", "consumes": [], "produces": [ "application/json", "text/json", "application/problem+json" ], "parameters": [ { "name": "Id", "in": "path", "description": "Package id", "required": true, "type": "string" }, { "name": "action", "in": "query", "description": "Package action (Reply, ReplyAll, Forward, Resend)", "required": false, "type": "string" }, { "name": "mailboxId", "in": "query", "description": "Mailbox id", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/PackageDetailsModel" } }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/ErrorModel" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "security": [ { "Authorization": [] } ] }, "delete": { "tags": [ "Packages" ], "summary": "Remove package from user's mailboxes", "operationId": "DELETEapi/v1/packages/{Id}?MailboxId={MailboxId}-1.0", "consumes": [], "produces": [ "application/json", "text/json", "application/problem+json" ], "parameters": [ { "name": "Id", "in": "path", "description": "Package id", "required": true, "type": "string" }, { "name": "mailboxId", "in": "query", "description": "Mailbox id", "required": false, "type": "string" } ], "responses": { "204": { "description": "No Content", "schema": { "$ref": "#/definitions/Void" } }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/ErrorModel" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "security": [ { "Authorization": [] } ] }, "patch": { "tags": [ "Packages" ], "summary": "Partial package update", "operationId": "PATCHapi/v1/packages/{Id}-1.0", "consumes": [ "application/json", "text/json", "application/problem+json" ], "produces": [ "application/json", "text/json", "application/problem+json" ], "parameters": [ { "name": "Id", "in": "path", "description": "ID of the package to update", "required": true, "type": "string" }, { "name": "body", "in": "body", "description": "Request body.", "required": true, "schema": { "$ref": "#/definitions/PackagePatchModel" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/SimplePackageModel" } }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/ErrorModel" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "security": [ { "Authorization": [] } ] } }, "/api/v1/packages/{Id}/notification": { "get": { "tags": [ "Packages" ], "summary": "Get package notification message.", "operationId": "GETapi/v1/packages/{Id}/notification?IncludeImages={IncludeImages}&MailboxId={MailboxId}-1.0", "consumes": [], "produces": [ "application/json", "text/json", "application/problem+json" ], "parameters": [ { "name": "Id", "in": "path", "description": "Package id", "required": true, "type": "string" }, { "name": "includeImages", "in": "query", "required": false, "type": "boolean" }, { "name": "mailboxId", "in": "query", "description": "Mailbox id", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/NotificationModel" } }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/ErrorModel" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "security": [ { "Authorization": [] } ] } }, "/api/v1/packages/attachments": { "post": { "tags": [ "Packages" ], "summary": "Upload attachment.", "description": "The content type of the request must be \"multipart/form-data\".\r\nFor large files upload (larger then maxAllowedContentLength attribute in Web.config) use chunked upload.\r\nSome clients, like Swagger and Postman, are not using chunked upload, so the upload might fail with unexpected error (404.13)\r\nMore info how to setup chunked upload: https://www.ipswitch.com/Transfer2018/ChunkedUploaderExample/", "operationId": "POSTapi/v1/packages/attachments-1.0", "consumes": [ "multipart/form-data" ], "produces": [], "parameters": [ { "name": "hashtype", "in": "formData", "description": "Type of hash provided (sha-1, sha-256, sha-384, sha-512)", "required": false, "type": "string" }, { "name": "hash", "in": "formData", "description": "Hash of file", "required": false, "type": "string" }, { "name": "file", "in": "formData", "description": "File contents", "required": true, "type": "file" }, { "name": "comments", "in": "formData", "description": "File upload comments", "required": false, "type": "string" } ], "responses": { "201": { "description": "Created", "schema": { "$ref": "#/definitions/FileDetailsModel" } }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/ErrorModel" } }, "422": { "description": "Invalid Request Parameters", "schema": { "$ref": "#/definitions/UnprocessableEntityErrorModel" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "security": [ { "Authorization": [] } ] } }, "/api/v1/packages/attachments/{Id}": { "delete": { "tags": [ "Packages" ], "summary": "Delete attachment.", "operationId": "DELETEapi/v1/packages/attachments/{Id}-1.0", "consumes": [], "produces": [ "application/json", "text/json", "application/problem+json" ], "parameters": [ { "name": "Id", "in": "path", "description": "File ID", "required": true, "type": "string" } ], "responses": { "204": { "description": "No Content", "schema": { "$ref": "#/definitions/Void" } }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/ErrorModel" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "security": [ { "Authorization": [] } ] } }, "/api/v1/info": { "get": { "tags": [ "PublicOrganizationInfo" ], "summary": "Gets public information about organization", "operationId": "GETapi/v1/info?orgId={orgId}&language={language}-1.0", "consumes": [], "produces": [ "application/json", "text/json", "application/problem+json" ], "parameters": [ { "name": "orgId", "in": "query", "description": "Organization ID", "required": false, "type": "integer", "format": "int32", "default": -1 }, { "name": "language", "in": "query", "description": "Response language", "required": false, "type": "string", "default": "" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/PublicOrgModel" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "security": [ { "Authorization": [] } ] } }, "/api/v1/reports/{Id}/results/download": { "get": { "tags": [ "Reports" ], "summary": "Download report run result", "operationId": "GETapi/v1/reports/{Id}/results/download?Format={Format}-1.0", "consumes": [], "produces": [ "application/json", "text/json", "application/problem+json" ], "parameters": [ { "name": "Id", "in": "path", "description": "Report Id", "required": true, "type": "string" }, { "name": "format", "in": "query", "description": "Report output format. If value is null, the default report format is used.", "required": false, "type": "string", "enum": [ "XML", "CSV", "HTMLNAKED", "HTMLSTYLED", "Unknown" ] } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/ErrorModel" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "security": [ { "Authorization": [] } ] } }, "/api/v1/reports": { "get": { "tags": [ "Reports" ], "summary": "Get all reports current user can view", "operationId": "GETapi/v1/reports?Page={Page}&PerPage={PerPage}&SortField={SortField}&SortDirection={SortDirection}-1.0", "consumes": [], "produces": [ "application/json", "text/json", "application/problem+json" ], "parameters": [ { "name": "page", "in": "query", "description": "Page number to display", "required": false, "type": "integer", "format": "int32" }, { "name": "perPage", "in": "query", "description": "Items per page in result collection; Default is 25", "required": false, "type": "integer", "format": "int32" }, { "name": "sortField", "in": "query", "description": "Name of field to sort the results by. (title); Default is title.", "required": false, "type": "string" }, { "name": "sortDirection", "in": "query", "description": "Sort direction; Default is ascending.", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/PagedModelOfSimpleReportModel" } }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/ErrorModel" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "security": [ { "Authorization": [] } ] } }, "/api/v1/reports/import": { "post": { "tags": [ "Reports" ], "summary": "Create new custom report from file", "description": "The content type of the request must be \"multipart/form-data\".", "operationId": "POSTapi/v1/reports/import-1.0", "consumes": [ "multipart/form-data" ], "produces": [ "application/json", "text/json", "application/problem+json" ], "parameters": [ { "name": "file", "in": "formData", "description": "Report xml file", "required": true, "type": "file" } ], "responses": { "201": { "description": "Created", "schema": { "$ref": "#/definitions/ReportDetailedModel" } }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/ErrorModel" } }, "422": { "description": "Invalid Request Parameters", "schema": { "$ref": "#/definitions/UnprocessableEntityErrorModel" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "security": [ { "Authorization": [] } ] } }, "/api/v1/settings/security/ipwhitelist": { "get": { "tags": [ "SecuritySettings" ], "summary": "Lists all IP Whitelist entries in user's organization.", "operationId": "GETapi/v1/settings/security/ipwhitelist?Page={Page}&PerPage={PerPage}&SortField={SortField}&SortDirection={SortDirection}-1.0", "consumes": [], "produces": [ "application/json", "text/json", "application/problem+json" ], "parameters": [ { "name": "page", "in": "query", "description": "Page number to display", "required": false, "type": "integer", "format": "int32" }, { "name": "perPage", "in": "query", "description": "Items per page in result collection; Default is 25", "required": false, "type": "integer", "format": "int32" }, { "name": "sortField", "in": "query", "description": "Name of field to sort the results by. (IPAddress, Id, Comment); Default is IPAddress.", "required": false, "type": "string" }, { "name": "sortDirection", "in": "query", "description": "Sort direction; Default is ascending.", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/PagedModelOfWhitelistedIPDto" } }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/ErrorModel" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "security": [ { "Authorization": [] } ] }, "post": { "tags": [ "SecuritySettings" ], "summary": "Adds a new IP Whitelist entry.", "operationId": "POSTapi/v1/settings/security/ipwhitelist-1.0", "consumes": [ "application/json", "text/json", "application/problem+json" ], "produces": [ "application/json", "text/json", "application/problem+json" ], "parameters": [ { "name": "body", "in": "body", "description": "Request body containing IP Address / IP Address range and comment", "required": true, "schema": { "$ref": "#/definitions/IPWhitelistRequestModel" } } ], "responses": { "201": { "description": "Created", "schema": { "$ref": "#/definitions/IPWhitelistResponseModel" } }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/ErrorModel" } }, "422": { "description": "Invalid Request Parameters", "schema": { "$ref": "#/definitions/UnprocessableEntityErrorModel" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "security": [ { "Authorization": [] } ] } }, "/api/v1/settings/security/password/aging/policies": { "get": { "tags": [ "SecuritySettings" ], "summary": "List password aging policies", "operationId": "GETapi/v1/settings/security/password/aging/policies?Page={Page}&PerPage={PerPage}&SortField={SortField}&SortDirection={SortDirection}-1.0", "consumes": [], "produces": [ "application/json", "text/json", "application/problem+json" ], "parameters": [ { "name": "page", "in": "query", "description": "Page number to display", "required": false, "type": "integer", "format": "int32" }, { "name": "perPage", "in": "query", "description": "Items per page in result collection; Default is 25", "required": false, "type": "integer", "format": "int32" }, { "name": "sortField", "in": "query", "description": "Name of field to sort the results by. (name); Default is Name.", "required": false, "type": "string" }, { "name": "sortDirection", "in": "query", "description": "Sort direction; Default is ascending.", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/PagedModelOfSimplePasswordAgingPolicyModel" } } }, "security": [ { "Authorization": [] } ] }, "post": { "tags": [ "SecuritySettings" ], "summary": "Create password aging policy", "operationId": "POSTapi/v1/settings/security/password/aging/policies-1.0", "consumes": [ "application/json", "text/json", "application/problem+json" ], "produces": [ "application/json", "text/json", "application/problem+json" ], "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/PasswordAgingPolicyAddModel" } } ], "responses": { "201": { "description": "Created", "schema": { "$ref": "#/definitions/PasswordAgingPolicyModel" } } }, "security": [ { "Authorization": [] } ] } }, "/api/v1/settings/security/userauth/expiration/policies": { "get": { "tags": [ "SecuritySettings" ], "summary": "List user auth expiration policies", "operationId": "GETapi/v1/settings/security/userauth/expiration/policies?Page={Page}&PerPage={PerPage}&SortField={SortField}&SortDirection={SortDirection}-1.0", "consumes": [], "produces": [ "application/json", "text/json", "application/problem+json" ], "parameters": [ { "name": "page", "in": "query", "description": "Page number to display", "required": false, "type": "integer", "format": "int32" }, { "name": "perPage", "in": "query", "description": "Items per page in result collection; Default is 25", "required": false, "type": "integer", "format": "int32" }, { "name": "sortField", "in": "query", "description": "Name of field to sort the results by. (name); Default is Name.", "required": false, "type": "string" }, { "name": "sortDirection", "in": "query", "description": "Sort direction; Default is ascending.", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/PagedModelOfSimpleExpirationPolicyModel" } } }, "security": [ { "Authorization": [] } ] }, "post": { "tags": [ "SecuritySettings" ], "summary": "Create user auth expiration policy", "operationId": "POSTapi/v1/settings/security/userauth/expiration/policies-1.0", "consumes": [ "application/json", "text/json", "application/problem+json" ], "produces": [ "application/json", "text/json", "application/problem+json" ], "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/ExpirationPolicyAddModel" } } ], "responses": { "201": { "description": "Created", "schema": { "$ref": "#/definitions/ExpirationPolicyModel" } } }, "security": [ { "Authorization": [] } ] } }, "/api/v1/settings/security/ipwhitelist/{entryId}": { "put": { "tags": [ "SecuritySettings" ], "summary": "Updates / replaces an existing IP Whitelist entry.", "operationId": "PUTapi/v1/settings/security/ipwhitelist/{entryId}-1.0", "consumes": [ "application/json", "text/json", "application/problem+json" ], "produces": [ "application/json", "text/json", "application/problem+json" ], "parameters": [ { "name": "entryId", "in": "path", "description": "Entry ID", "required": true, "type": "integer", "format": "int32" }, { "name": "body", "in": "body", "description": "Request body containing IP Address / IP Address range and comment", "required": true, "schema": { "$ref": "#/definitions/IPWhitelistRequestModel" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/IPWhitelistResponseModel" } }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/ErrorModel" } }, "422": { "description": "Invalid Request Parameters", "schema": { "$ref": "#/definitions/UnprocessableEntityErrorModel" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "security": [ { "Authorization": [] } ] }, "delete": { "tags": [ "SecuritySettings" ], "summary": "Removes an IP Whitelist entry.", "operationId": "DELETEapi/v1/settings/security/ipwhitelist/{entryId}-1.0", "consumes": [], "produces": [ "application/json", "text/json", "application/problem+json" ], "parameters": [ { "name": "entryId", "in": "path", "description": "Entry ID", "required": true, "type": "integer", "format": "int32" } ], "responses": { "204": { "description": "No Content", "schema": { "$ref": "#/definitions/Void" } }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/ErrorModel" } }, "422": { "description": "Invalid Request Parameters", "schema": { "$ref": "#/definitions/UnprocessableEntityErrorModel" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "security": [ { "Authorization": [] } ] } }, "/api/v1/settings/security/remoteaccess/rules": { "post": { "tags": [ "SecuritySettings" ], "summary": "Create new default rule for remote access", "operationId": "POSTapi/v1/settings/security/remoteaccess/rules-1.0", "consumes": [ "application/json", "text/json", "application/problem+json" ], "produces": [ "application/json", "text/json", "application/problem+json" ], "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/RemoteAccessRuleAddModel" } } ], "responses": { "201": { "description": "Created", "schema": { "$ref": "#/definitions/RemoteAccessRuleModel" } } }, "security": [ { "Authorization": [] } ] } }, "/api/v1/settings/security/password/permissions": { "post": { "tags": [ "SecuritySettings" ], "summary": "Update password permissions settings", "operationId": "POSTapi/v1/settings/security/password/permissions-1.0", "consumes": [ "application/json", "text/json", "application/problem+json" ], "produces": [ "application/json", "text/json", "application/problem+json" ], "parameters": [ { "name": "request", "in": "body", "required": true, "schema": { "$ref": "#/definitions/PasswordPermissionsUpdateRequest" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/PasswordPermissionsModel" } } }, "security": [ { "Authorization": [] } ] } }, "/api/v1/settings/security/password/aging": { "patch": { "tags": [ "SecuritySettings" ], "summary": "Update account user password aging policy", "operationId": "PATCHapi/v1/settings/security/password/aging-1.0", "consumes": [ "application/json", "text/json", "application/problem+json" ], "produces": [ "application/json", "text/json", "application/problem+json" ], "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/UserClassPasswordAgingPolicyPatchModel" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UserClassPasswordAgingPolicyModel" } } }, "security": [ { "Authorization": [] } ] } }, "/api/v1/settings/security/userauth/expiration": { "patch": { "tags": [ "SecuritySettings" ], "summary": "Update account user auth expiration policy", "operationId": "PATCHapi/v1/settings/security/userauth/expiration-1.0", "consumes": [ "application/json", "text/json", "application/problem+json" ], "produces": [ "application/json", "text/json", "application/problem+json" ], "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/UserClassExpirationPolicyPatchModel" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UserClassExpirationPolicyModel" } } }, "security": [ { "Authorization": [] } ] } }, "/api/v1/serverinfo": { "get": { "tags": [ "ServerInfo" ], "summary": "Gets information about server", "operationId": "GETapi/v1/serverinfo-1.0", "consumes": [], "produces": [ "application/json", "text/json", "application/problem+json" ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/api/v1/xferstatus": { "get": { "tags": [ "TransferStatus" ], "summary": "Gets Transfer status information", "operationId": "GETapi/v1/xferstatus-1.0", "consumes": [], "produces": [ "application/json", "text/json", "application/problem+json" ], "parameters": [ { "name": "recentlyCompletedPeriod", "in": "query", "description": "Time period in seconds to return recently completed data. Default: 0", "required": false, "type": "integer", "format": "int32" }, { "name": "statusDistributionPeriod", "in": "query", "description": "Time period in seconds to calculate status distribution for. Default: RecentlyCompletedPeriod", "required": false, "type": "integer", "format": "int32" }, { "name": "userLoginName", "in": "query", "description": "Filter expression for Login name", "required": false, "type": "string" }, { "name": "userFullName", "in": "query", "description": "Filter expression for User Display name", "required": false, "type": "string" }, { "name": "userIp", "in": "query", "description": "Filter expression for User IP", "required": false, "type": "string" }, { "name": "folderName", "in": "query", "description": "Filter expression for Folder name", "required": false, "type": "string" }, { "name": "fileName", "in": "query", "description": "Filter expression for File name", "required": false, "type": "string" }, { "name": "transferStatus", "in": "query", "description": "Filter for status. Uses OR logic", "required": false, "items": { "type": "string", "enum": [ "Failed", "Stalled", "Active", "Completed" ] }, "collectionFormat": "multi", "type": "array" }, { "name": "search", "in": "query", "description": "Filter expression for several fields. Fields are matched with OR logic. AND logic is used if you provide expression for each particular query. Fields being matched: userLoginName, userFullName, userIp, folderName, fileName", "required": false, "type": "string" }, { "name": "page", "in": "query", "description": "Page number to display", "required": false, "type": "integer", "format": "int32" }, { "name": "perPage", "in": "query", "description": "Items per page in result collection", "required": false, "type": "integer", "format": "int32" }, { "name": "sortField", "in": "query", "description": "Name of field to sort the results by.", "required": false, "type": "string" }, { "name": "sortDirection", "in": "query", "description": "Sort direction; Default is ascending.", "required": false, "type": "string" }, { "name": "useDisplayTimeZone", "in": "query", "description": "Whether to convert timestamps returned by the endpoint from the server's\r\ntime zone to the user's configured display time zone.", "required": false, "type": "boolean" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/TransferStatusPagedModel" } }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/ErrorModel" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "security": [ { "Authorization": [] } ] } }, "/api/v1/users/self": { "get": { "tags": [ "Users" ], "summary": "Get current user details", "operationId": "GETapi/v1/users/self-1.0", "consumes": [], "produces": [ "application/json", "text/json", "application/problem+json" ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UserDetailsModel" } }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/ErrorModel" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "security": [ { "Authorization": [] } ] } }, "/api/v1/users/{Id}": { "get": { "tags": [ "Users" ], "summary": "Get user details", "operationId": "GETapi/v1/users/{Id}-1.0", "consumes": [], "produces": [ "application/json", "text/json", "application/problem+json" ], "parameters": [ { "name": "Id", "in": "path", "description": "User ID", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UserDetailsModel" } }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/ErrorModel" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "security": [ { "Authorization": [] } ] }, "delete": { "tags": [ "Users" ], "summary": "Delete user", "operationId": "DELETEapi/v1/users/{Id}-1.0", "consumes": [], "produces": [ "application/json", "text/json", "application/problem+json" ], "parameters": [ { "name": "Id", "in": "path", "description": "User ID", "required": true, "type": "string" } ], "responses": { "204": { "description": "No Content", "schema": { "$ref": "#/definitions/Void" } }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/ErrorModel" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "security": [ { "Authorization": [] } ] }, "patch": { "tags": [ "Users" ], "summary": "Partial user update", "operationId": "PATCHapi/v1/users/{Id}-1.0", "consumes": [ "application/json", "text/json", "application/problem+json" ], "produces": [ "application/json", "text/json", "application/problem+json" ], "parameters": [ { "name": "Id", "in": "path", "description": "ID of user to update", "required": true, "type": "string" }, { "name": "body", "in": "body", "description": "Request body.", "required": true, "schema": { "$ref": "#/definitions/UserPatchModel" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UserDetailsModel" } }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/ErrorModel" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "security": [ { "Authorization": [] } ] } }, "/api/v1/users/{Id}/groups": { "get": { "tags": [ "Users" ], "summary": "Get list of user groups", "operationId": "GETapi/v1/users/{Id}/groups?Page={Page}&PerPage={PerPage}-1.0", "consumes": [], "produces": [ "application/json", "text/json", "application/problem+json" ], "parameters": [ { "name": "Id", "in": "path", "description": "User ID.", "required": true, "type": "string" }, { "name": "page", "in": "query", "description": "Page number to display", "required": false, "type": "integer", "format": "int32" }, { "name": "perPage", "in": "query", "description": "Items per page in result collection; Default is 25", "required": false, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/PagedModelOfUserGroupModel" } }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/ErrorModel" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "security": [ { "Authorization": [] } ] } }, "/api/v1/users/self/externaltokens": { "get": { "tags": [ "Users" ], "summary": "Get current user external tokens", "operationId": "GETapi/v1/users/self/externaltokens?Page={Page}&PerPage={PerPage}&SortField={SortField}&SortDirection={SortDirection}-1.0", "consumes": [], "produces": [ "application/json", "text/json", "application/problem+json" ], "parameters": [ { "name": "page", "in": "query", "description": "Page number to display", "required": false, "type": "integer", "format": "int32" }, { "name": "perPage", "in": "query", "description": "Items per page in result collection; Default is 25", "required": false, "type": "integer", "format": "int32" }, { "name": "sortField", "in": "query", "description": "Name of field to sort the results by. (TokenId, LastUsed, RegisteredAt or TokenType); Default is DisplayName.", "required": false, "type": "string" }, { "name": "sortDirection", "in": "query", "description": "Sort direction; Default is ascending.", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/PagedModelOfUserExternalTokenModel" } }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/ErrorModel" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "security": [ { "Authorization": [] } ] }, "post": { "tags": [ "Users" ], "summary": "Register an external token with the current user's account.", "operationId": "POSTapi/v1/users/self/externaltokens-1.0", "consumes": [ "application/json", "text/json", "application/problem+json" ], "produces": [ "application/json", "text/json", "application/problem+json" ], "parameters": [ { "name": "request", "in": "body", "description": "Request to register an external token with the current user account.", "required": true, "schema": { "$ref": "#/definitions/RegisterExternalTokenRequest" } } ], "responses": { "204": { "description": "No Content", "schema": { "$ref": "#/definitions/Void" } }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/ErrorModel" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "security": [ { "Authorization": [] } ] }, "delete": { "tags": [ "Users" ], "summary": "Delete external token of the current user using the encoded token string.", "operationId": "DELETEapi/v1/users/self/externaltokens-1.0", "consumes": [ "application/json", "text/json", "application/problem+json" ], "produces": [ "application/json", "text/json", "application/problem+json" ], "parameters": [ { "name": "request", "in": "body", "description": "Request to delete an external token using the encoded token string.", "required": true, "schema": { "$ref": "#/definitions/CurrentUserDeleteExternalTokenByTokenRequest" } } ], "responses": { "204": { "description": "No Content", "schema": { "$ref": "#/definitions/Void" } }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/ErrorModel" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "security": [ { "Authorization": [] } ] } }, "/api/v1/users/{Id}/externaltokens": { "get": { "tags": [ "Users" ], "summary": "Get user external tokens", "operationId": "GETapi/v1/users/{Id}/externaltokens?Page={Page}&PerPage={PerPage}&SortField={SortField}&SortDirection={SortDirection}-1.0", "consumes": [], "produces": [ "application/json", "text/json", "application/problem+json" ], "parameters": [ { "name": "Id", "in": "path", "description": "User ID.", "required": true, "type": "string" }, { "name": "page", "in": "query", "description": "Page number to display", "required": false, "type": "integer", "format": "int32" }, { "name": "perPage", "in": "query", "description": "Items per page in result collection; Default is 25", "required": false, "type": "integer", "format": "int32" }, { "name": "sortField", "in": "query", "description": "Name of field to sort the results by. (TokenId, LastUsed, RegisteredAt or TokenType); Default is DisplayName.", "required": false, "type": "string" }, { "name": "sortDirection", "in": "query", "description": "Sort direction; Default is ascending.", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/PagedModelOfUserExternalTokenModel" } }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/ErrorModel" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "security": [ { "Authorization": [] } ] } }, "/api/v1/users": { "get": { "tags": [ "Users" ], "summary": "Get list of users", "operationId": "GETapi/v1/users?Page={Page}&PerPage={PerPage}&SortField={SortField}&SortDirection={SortDirection}&Permission={Permission}&Status={Status}&Username={Username}&FullName={FullName}&Email={Email}&IsExactMatch={IsExactMatch}&OrgId={OrgId}-1.0", "consumes": [], "produces": [ "application/json", "text/json", "application/problem+json" ], "parameters": [ { "name": "page", "in": "query", "description": "Page number to display.", "required": false, "type": "integer", "format": "int32" }, { "name": "perPage", "in": "query", "description": "Items per page in result collection; Default is 25.", "required": false, "type": "integer", "format": "int32" }, { "name": "sortField", "in": "query", "description": "Name of field to sort the results by. (username, fullname, lastLoginStamp or email); Default is username.", "required": false, "type": "string" }, { "name": "sortDirection", "in": "query", "description": "Sort direction; Default is ascending.", "required": false, "type": "string" }, { "name": "permission", "in": "query", "description": "User permission filter.", "required": false, "type": "string", "enum": [ "AllUsers", "EndUsers", "Administrators", "FileAdmins", "GroupAdmins", "TemporaryUsers", "SysAdmins", "AuditUsers" ] }, { "name": "status", "in": "query", "description": "User status filter.", "required": false, "type": "string", "enum": [ "AllUsers", "ActiveUsers", "InactiveUsers", "NeverSignedOnUsers", "TemplateUsers" ] }, { "name": "username", "in": "query", "description": "User login name.", "required": false, "type": "string" }, { "name": "fullName", "in": "query", "description": "User full name.", "required": false, "type": "string" }, { "name": "email", "in": "query", "description": "User email.", "required": false, "type": "string" }, { "name": "isExactMatch", "in": "query", "description": "If true, it will search for exact match of username, fullname and email.", "required": false, "type": "boolean" }, { "name": "orgId", "in": "query", "description": "Organization ID. (For sysadmin users only. For non sysadmin users current user organization ID is used.)", "required": false, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/PagedModelOfSimpleUserModel" } }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/ErrorModel" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "security": [ { "Authorization": [] } ] }, "post": { "tags": [ "Users" ], "summary": "Create new user", "description": "If SourceUserId specified in user model clone operation will be executed", "operationId": "POSTapi/v1/users-1.0", "consumes": [ "application/json", "text/json", "application/problem+json" ], "produces": [ "application/json", "text/json", "application/problem+json" ], "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/AddUserModel" } } ], "responses": { "201": { "description": "Created", "schema": { "$ref": "#/definitions/UserDetailsModel" } }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/ErrorModel" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "security": [ { "Authorization": [] } ] } }, "/api/v1/users/self/externaltokens/{Id}": { "delete": { "tags": [ "Users" ], "summary": "Delete external token of the current user.", "operationId": "DELETEapi/v1/users/self/externaltokens/{Id}-1.0", "consumes": [], "produces": [ "application/json", "text/json", "application/problem+json" ], "parameters": [ { "name": "Id", "in": "path", "description": "Token ID.", "required": true, "type": "string" } ], "responses": { "204": { "description": "No Content", "schema": { "$ref": "#/definitions/Void" } }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/ErrorModel" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "security": [ { "Authorization": [] } ] } }, "/api/v1/users/{UserId}/externaltokens/{Id}": { "delete": { "tags": [ "Users" ], "summary": "Delete external token of the user.", "operationId": "DELETEapi/v1/users/{UserId}/externaltokens/{Id}-1.0", "consumes": [], "produces": [ "application/json", "text/json", "application/problem+json" ], "parameters": [ { "name": "UserId", "in": "path", "description": "User ID.", "required": true, "type": "string" }, { "name": "Id", "in": "path", "description": "Token ID.", "required": true, "type": "string" } ], "responses": { "204": { "description": "No Content", "schema": { "$ref": "#/definitions/Void" } }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/ErrorModel" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ErrorModel" } } }, "security": [ { "Authorization": [] } ] } }, "/api/v1/token": { "post": { "tags": [ "Authentication" ], "summary": "Retrieve API token", "description": "Retrieve API token", "operationId": "Auth_GetToken", "consumes": [ "application/x-www-form-urlencoded" ], "parameters": [ { "name": "grant_type", "in": "formData", "description": "Type of authentication used", "required": true, "type": "string", "enum": [ "password", "refresh_token", "otp", "code", "external_token", "oidc_token" ] }, { "name": "username", "in": "formData", "description": "User name. Use with \"password\" or \"otp\" grant_type", "required": false, "type": "string" }, { "name": "password", "in": "formData", "description": "User password. Use with \"password\" or \"otp\" grant_type", "required": false, "type": "string" }, { "name": "language", "in": "formData", "description": "Language to use. Optional. Use with \"password\", \"otp\" or \"code\" grant_type", "required": false, "type": "string" }, { "name": "orgId", "in": "formData", "description": "Organization ID to authenticate against. Optional. Use with \"password\", \"otp\" or \"code\" grant_type", "required": false, "type": "string" }, { "name": "refresh_token", "in": "formData", "description": "Refresh token. Use with \"refresh_token\" grant_type", "required": false, "type": "string" }, { "name": "mfa_access_token", "in": "formData", "description": "Multi-factor authentication access token. Use with \"otp\" grant_type", "required": false, "type": "string" }, { "name": "otp", "in": "formData", "description": "One-time password. Use with \"otp\" grant_type", "required": false, "type": "string" }, { "name": "code", "in": "formData", "description": "Authorization code. Use with \"code\" grant_type", "required": false, "type": "string" }, { "name": "code_verifier", "in": "formData", "description": "Code verifier. Use with \"code\" grant_type", "required": false, "type": "string" }, { "name": "accept_security_notice", "in": "formData", "description": "Accept security notice. Use with \"password\", \"otp\" or \"oidc_token\" grant_type", "required": false, "type": "bool" }, { "name": "mfa_remember_this_device", "in": "formData", "description": "Multi-factor authentication remember this device. Use with \"otp\" grant_type", "required": false, "type": "bool" }, { "name": "mfa_trust_device_token", "in": "formData", "description": "Multi-factor authentication trust device token. Use with \"password\" grant_type", "required": false, "type": "string" }, { "name": "external_token_type", "in": "formData", "description": "External token type. Use with \"external_token\" grant_type", "required": false, "type": "string", "enum": [ "MicrosoftOutlook" ] }, { "name": "external_token", "in": "formData", "description": "External token. Use with \"external_token\" grant type", "required": false, "type": "string" }, { "name": "new_password", "in": "formData", "description": "New password to apply to account when required to change password. Use with \"password\" or \"otp\" grant_type.", "required": false, "type": "string" }, { "name": "id_token", "in": "formData", "description": "OIDC id token. Use with \"oidc_token\" grant type", "required": false, "type": "string" }, { "name": "idp_id", "in": "formData", "description": "Identity provider identifier. Use with \"oidc_token\" grant type", "required": false, "type": "string" } ], "responses": { "200": { "description": "Represents successful token request response", "schema": { "$ref": "#/definitions/TokenAcquiredModel" } }, "400": { "description": "Authentication failed error", "schema": { "$ref": "#/definitions/RequestTokenError" } }, "400 (Password Change Required)": { "description": "Password change required error", "schema": { "$ref": "#/definitions/RequestTokenPasswordChangeRequiredError" } }, "400 (Security Notice Acceptance Required)": { "description": "Security notice acceptance required error", "schema": { "$ref": "#/definitions/RequestTokenSecurityNoticeAcceptanceRequiredError" } }, "401": { "description": "Multi-factor authentication required error", "schema": { "$ref": "#/definitions/RequestTokenMfaError" } }, "412": { "description": "Setup multi-factor authentication required error", "schema": { "$ref": "#/definitions/RequestTokenError" } } } } }, "/api/v1/token/revoke": { "post": { "tags": [ "Authentication" ], "summary": "Revokes API token", "description": "Response for Revoke token operation", "operationId": "Auth_RevokeToken", "consumes": [ "application/x-www-form-urlencoded" ], "parameters": [ { "name": "token", "in": "formData", "description": "Access token or Refresh token to revoke", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/RevokeTokenResponse" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/RevokeTokenResponse" } } } } }, "/api/v1/token/otp": { "post": { "tags": [ "Authentication" ], "summary": "Send one-time password", "description": "Response for send otp operation", "operationId": "Auth_SendOtp", "consumes": [ "application/x-www-form-urlencoded" ], "parameters": [ { "name": "mfa_access_token", "in": "formData", "description": "Multi-factor authentication access token", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/SendOtpResponseModel" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/RevokeTokenResponse" } } } } } }, "definitions": { "AdHocTransferAgingExpirationRequest": { "properties": {}, "xml": { "name": "AdHocTransferAgingExpirationRequest" }, "type": "object" }, "AdHocTransferAgingExpirationModel": { "properties": { "packageRemainsNewForHours": { "description": "Number of hours packages remain new.", "type": "integer", "format": "int32" }, "maxUserPackageExpirationHours": { "description": "Number of hours after packages expire and delete.\r\n-1 if not applied.", "type": "integer", "format": "int32" }, "archivePackages": { "description": "Archive expired packages to the location before deleting.", "type": "boolean" }, "defaultUserPackageExpirationHours": { "description": "Value in hours which users can set specific expirations on their packages.\r\n-1 if not allowed.", "type": "integer", "format": "int32" } }, "xml": { "name": "AdHocTransferAgingExpirationModel" }, "type": "object" }, "ErrorModel": { "description": "Represents an error returned by API", "properties": { "detail": { "description": "An explanation specific to this occurrence of the error", "type": "string" }, "errorCode": { "description": "An error number, defined by the application", "type": "integer", "format": "int32", "default": 0 }, "title": { "description": "Short summary of the error type", "type": "string" } }, "xml": { "name": "ErrorModel" }, "type": "object" }, "LogosModel": { "properties": { "leftLogoFilename": { "type": "string" }, "rightLogoFilename": { "type": "string" }, "backgroundLogoFilename": { "type": "string" }, "useCustomNotifBranding": { "type": "boolean" } }, "xml": { "name": "LogosModel" }, "type": "object" }, "UnprocessableEntityErrorModel": { "description": "Represents an error returned by API in case of HTTP 422 error", "properties": { "errors": { "description": "Detailed information about errors in provided parameters", "items": { "$ref": "#/definitions/FieldErrorModel" }, "readOnly": true, "xml": { "name": "FieldErrorModel", "wrapped": true }, "type": "array" }, "detail": { "description": "An explanation specific to this occurrence of the error", "type": "string" }, "errorCode": { "description": "An error number, defined by the application", "type": "integer", "format": "int32", "default": 0 }, "title": { "description": "Short summary of the error type", "type": "string" } }, "xml": { "name": "UnprocessableEntityErrorModel" }, "type": "object" }, "FieldErrorModel": { "description": "Describes error in particular parameter of the request", "properties": { "field": { "description": "Name of the field that's invalid", "type": "string" }, "rejected": { "description": "Value of the field that's invalid", "type": "string" }, "message": { "description": "Explanation of the error", "type": "string" } }, "xml": { "name": "FieldErrorModel" }, "type": "object" }, "IdentityProvidersListRequest": { "properties": { "page": { "description": "Page number to display", "type": "integer", "format": "int32" }, "perPage": { "description": "Items per page in result collection; Default is 25", "type": "integer", "format": "int32" }, "sortField": { "description": "Name of field to sort the results by. (name); Default is Name.", "type": "string" }, "sortDirection": { "description": "Sort direction; Default is ascending.", "type": "string" }, "orgId": { "description": "Organization Id.", "type": "integer", "format": "int32" } }, "xml": { "name": "IdentityProvidersListRequest" }, "type": "object" }, "PagedModelOfPublicIdPInformationModel": { "description": "Represents paged response object with proper navigations", "properties": { "items": { "description": "Items on the given page", "items": { "$ref": "#/definitions/PublicIdPInformationModel" }, "readOnly": true, "xml": { "name": "PublicIdPInformationModel", "wrapped": true }, "type": "array" }, "paging": { "$ref": "#/definitions/PagingInfoModel", "description": "Paging data for given response" }, "sorting": { "description": "Sorting data for given response", "items": { "$ref": "#/definitions/SortFieldDto" }, "xml": { "name": "SortFieldDto", "wrapped": true }, "type": "array" } }, "xml": { "name": "PagedModel`1" }, "type": "object" }, "PublicIdPInformationModel": { "properties": { "name": { "description": "Name of the identity provider.", "type": "string" }, "link": { "description": "Direct link to the identity provider.", "type": "string" } }, "xml": { "name": "PublicIdPInformationModel" }, "type": "object" }, "PagingInfoModel": { "description": "Information about paging for collection response", "properties": { "page": { "description": "Current page in collection", "type": "integer", "format": "int32" }, "perPage": { "description": "Items per page", "type": "integer", "format": "int32" }, "totalItems": { "description": "Total items in collection", "type": "integer", "format": "int64" }, "totalPages": { "description": "Total number of pages in collection", "readOnly": true, "type": "integer", "format": "int32" } }, "xml": { "name": "PagingInfoModel" }, "type": "object" }, "SortFieldDto": { "properties": { "sortField": { "type": "string" }, "sortDirection": { "type": "string", "enum": [ "asc", "desc" ] } }, "xml": { "name": "SortFieldDto" }, "type": "object" }, "OrgRequest": { "properties": { "orgId": { "description": "The Id of the target Org for this request", "type": "integer", "format": "int32" } }, "xml": { "name": "OrgRequest" }, "type": "object" }, "ActAsAdminDto": { "properties": { "orgId": { "type": "integer", "format": "int32" }, "permission": { "type": "string", "enum": [ "Anonymous", "TemporaryUser", "User", "AuditUser", "FileAdmin", "Admin", "SysAdmin" ] } }, "xml": { "name": "ActAsAdminDto" }, "type": "object" }, "ContactListRequest": { "properties": { "searchString": { "description": "Search String. The Name and Email values will be searched.", "type": "string" }, "onBehalfOf": { "description": "User to get contacts on behalf of.", "type": "string" }, "page": { "description": "Page number to display", "type": "integer", "format": "int32" }, "perPage": { "description": "Items per page in result collection; Default is 25", "type": "integer", "format": "int32" }, "sortField": { "description": "Name of field to sort the results by. (email, name); Default is Name.", "type": "string" }, "sortDirection": { "description": "Sort direction; Default is ascending.", "type": "string" } }, "xml": { "name": "ContactListRequest" }, "type": "object" }, "PagedModelOfContactModel": { "description": "Represents paged response object with proper navigations", "properties": { "items": { "description": "Items on the given page", "items": { "$ref": "#/definitions/ContactModel" }, "readOnly": true, "xml": { "name": "ContactModel", "wrapped": true }, "type": "array" }, "paging": { "$ref": "#/definitions/PagingInfoModel", "description": "Paging data for given response" }, "sorting": { "description": "Sorting data for given response", "items": { "$ref": "#/definitions/SortFieldDto" }, "xml": { "name": "SortFieldDto", "wrapped": true }, "type": "array" } }, "xml": { "name": "PagedModel`1" }, "type": "object" }, "ContactModel": { "description": "Represents basic contact data required for all scenarios", "properties": { "name": { "description": "Contact name.", "type": "string" }, "email": { "description": "Contact email address.", "type": "string" }, "identifier": { "description": "Contact ID.", "type": "string" }, "type": { "description": "Contact type (user, group, unreg).", "type": "string", "enum": [ "User", "Group", "Unreg", "Unverified" ] } }, "xml": { "name": "ContactModel" }, "type": "object" }, "ContactAddModel": { "description": "Represents contact data required for create contact scenario", "required": [ "email" ], "properties": { "name": { "description": "Contact name.", "type": "string" }, "email": { "description": "Contact email address.", "type": "string" } }, "xml": { "name": "ContactAddModel" }, "type": "object" }, "ContactUpdateModel": { "properties": { "name": { "description": "Contact name.", "type": "string" }, "email": { "description": "Contact email address.", "type": "string" } }, "xml": { "name": "ContactUpdateModel" }, "type": "object" }, "ContactDeleteRequest": { "properties": { "id": { "description": "Contact ID", "type": "string" } }, "xml": { "name": "ContactDeleteRequest" }, "type": "object" }, "Void": { "properties": {}, "xml": { "name": "Void" }, "type": "object" }, "FileRequest": { "properties": { "id": { "description": "File ID", "type": "string" } }, "xml": { "name": "FileRequest" }, "type": "object" }, "FileDetailsModel": { "description": "Represents a file and all available attributes", "properties": { "orgID": { "description": "ID of the organization this file exists in.", "type": "string" }, "originalFileType": { "description": "Describes what type of file this file was originally.", "type": "string", "enum": [ "Any", "Text", "HTML", "CSV", "XML", "WebPost", "AuditLog", "Message", "MessageArchive", "MessageDraft", "MessageTemplate", "Upload31", "Upload32" ] }, "currentFileType": { "description": "Describes what type of file this file is currently.", "type": "string", "enum": [ "Any", "Text", "HTML", "CSV", "XML", "WebPost", "AuditLog", "Message", "MessageArchive", "MessageDraft", "MessageTemplate", "Upload31", "Upload32" ] }, "uploadComment": { "description": "Any optional comments uploaded with this file.", "type": "string" }, "uploadIP": { "description": "The IP Address, if any, from which this file was uploaded.", "type": "string" }, "uploadAgentBrand": { "description": "Brand of the agent used to upload this file.", "type": "string" }, "uploadAgentVersion": { "description": "Version of the agent used to upload this file.", "type": "string" }, "uploadIntegrity": { "description": "1 if file was uploaded with integrity checking, 0 if file was not.", "type": "integer", "format": "int32" }, "dlpChecked": { "description": "If true, the file was determined to not have a DLP violation; otherwise, the file was either not checked, or does contain a violation.", "type": "boolean" }, "dlpMetaData": { "description": "If 1, the file’s metadata contains DLP violations, and should not be displayed. Otherwise, if 0, there are no DLP violations in the file metadata.", "type": "integer", "format": "int32" }, "dlpViolation": { "description": "File DLP violation info", "type": "string" }, "dlpBlocked": { "description": "When true, the file contains DLP violations that prevent it from being downloaded, according to currently configured DLP rules.", "type": "boolean" }, "uploadUserFullName": { "description": "The real name of the user account which uploaded this file.", "type": "string" }, "downloadCount": { "description": "Number of times this file has been downloaded.", "type": "integer", "format": "int32" }, "originalFilename": { "description": "The original name of this file.", "type": "string" }, "hash": { "description": "SHA-1 hash of the file", "type": "string" }, "folderID": { "description": "ID of the folder this file is currently in.", "type": "integer", "format": "int32" }, "uploadUsername": { "description": "The username of the user account which uploaded this file.", "type": "string" }, "path": { "description": "The full path of this file.", "type": "string" }, "uploadStamp": { "description": "The date and time this file was uploaded.", "type": "string" }, "isNew": { "description": "Indicating whether the file is considered new for the current user", "type": "boolean" }, "name": { "description": "The name of this file.", "type": "string" }, "size": { "description": "Size in bytes of this file.", "type": "integer", "format": "int64" }, "id": { "description": "The unique ID of the file. Also known as the tracking number.", "type": "string" } }, "xml": { "name": "FileDetailsModel" }, "type": "object" }, "FilePatchModel": { "description": "File Update parameters", "properties": { "name": { "description": "New file name to set", "type": "string" }, "isNew": { "description": "IsNew to set", "type": "boolean" } }, "xml": { "name": "FilePatchModel" }, "type": "object" }, "GetFilePublicLinkDetailsRequest": { "properties": { "id": { "description": "File ID", "type": "string" }, "filePublicLinkId": { "description": "Public link ID", "type": "string" } }, "xml": { "name": "GetFilePublicLinkDetailsRequest" }, "type": "object" }, "FilePublicLinkDetailsModel": { "properties": { "file": { "$ref": "#/definitions/PublicFileModel", "description": "File" }, "expirationValue": { "description": "Expiration value", "type": "string" }, "expirationType": { "description": "Expiration type", "type": "string", "enum": [ "Hour", "Day", "Week", "Month", "Date" ] }, "orgId": { "description": "Organization id", "type": "integer", "format": "int32" }, "id": { "description": "Public link id", "type": "string" }, "url": { "description": "Public link url", "type": "string" }, "downloadLimit": { "description": "Download limit. Can be null", "type": "integer", "format": "int32" }, "downloadCount": { "description": "Download count", "type": "integer", "format": "int32" }, "creationDate": { "description": "Creation date", "type": "string" }, "expirationDate": { "description": "Expiration Date", "type": "string" }, "creator": { "$ref": "#/definitions/SimpleUserModel", "description": "User who created link" } }, "xml": { "name": "FilePublicLinkDetailsModel" }, "type": "object" }, "PublicFileModel": { "description": "Public file model containing file properties.", "properties": { "name": { "description": "The name of this file.", "type": "string" }, "size": { "description": "Size in bytes of this file.", "type": "integer", "format": "int64" }, "id": { "description": "The unique ID of the file. Also known as the tracking number.", "type": "string" } }, "xml": { "name": "PublicFileModel" }, "type": "object" }, "SimpleUserModel": { "description": "Simple user model for user lists.", "properties": { "id": { "description": "User ID.", "type": "string" }, "orgID": { "description": "ID of organization user is a member of.", "type": "integer", "format": "int32" }, "username": { "description": "User login name.", "type": "string" }, "fullName": { "description": "User full name.", "type": "string" }, "permission": { "description": "User permission.", "type": "string", "enum": [ "Anonymous", "TemporaryUser", "User", "AuditUser", "FileAdmin", "Admin", "SysAdmin" ] }, "email": { "description": "User email address.", "type": "string" }, "status": { "description": "User security status.", "type": "string", "enum": [ "Active", "Suspended", "Template" ] }, "lastLoginStamp": { "description": "Time of last user login. Null if user has not logged in yet.", "type": "string" } }, "xml": { "name": "SimpleUserModel" }, "type": "object" }, "FileIsNewForUserPagedRequest": { "properties": { "page": { "description": "Page number to display", "type": "integer", "format": "int32" }, "perPage": { "description": "Items per page in result collection; Default is 25", "type": "integer", "format": "int32" }, "sortField": { "description": "Name of field to sort the results by. (username, isnew); Default is username.", "type": "string" }, "sortDirection": { "description": "Sort direction; Default is ascending.", "type": "string" }, "id": { "description": "File ID", "type": "string" } }, "xml": { "name": "FileIsNewForUserPagedRequest" }, "type": "object" }, "PagedModelOfFileIsNewForUserModel": { "description": "Represents paged response object with proper navigations", "properties": { "items": { "description": "Items on the given page", "items": { "$ref": "#/definitions/FileIsNewForUserModel" }, "readOnly": true, "xml": { "name": "FileIsNewForUserModel", "wrapped": true }, "type": "array" }, "paging": { "$ref": "#/definitions/PagingInfoModel", "description": "Paging data for given response" }, "sorting": { "description": "Sorting data for given response", "items": { "$ref": "#/definitions/SortFieldDto" }, "xml": { "name": "SortFieldDto", "wrapped": true }, "type": "array" } }, "xml": { "name": "PagedModel`1" }, "type": "object" }, "FileIsNewForUserModel": { "properties": { "user": { "$ref": "#/definitions/SimpleUserModel" }, "isNew": { "type": "boolean" } }, "xml": { "name": "FileIsNewForUserModel" }, "type": "object" }, "FileSetIsNewForUserModel": { "properties": { "userId": { "description": "User ID for user you want to reset/set file isNew state for", "type": "string" } }, "xml": { "name": "FileSetIsNewForUserModel" }, "type": "object" }, "GetFilePublicLinkListRequest": { "properties": { "id": { "description": "File ID", "type": "string" }, "page": { "description": "Page number to display", "type": "integer", "format": "int32" }, "perPage": { "description": "Items per page in result collection; Default is 25", "type": "integer", "format": "int32" }, "sortField": { "description": "Name of field to sort the results by. (creationDate); Default is creationDate.", "type": "string" }, "sortDirection": { "description": "Sort direction; Default is ascending.", "type": "string" } }, "xml": { "name": "GetFilePublicLinkListRequest" }, "type": "object" }, "PagedModelOfSimpleFilePublicLinkModel": { "description": "Represents paged response object with proper navigations", "properties": { "items": { "description": "Items on the given page", "items": { "$ref": "#/definitions/SimpleFilePublicLinkModel" }, "readOnly": true, "xml": { "name": "SimpleFilePublicLinkModel", "wrapped": true }, "type": "array" }, "paging": { "$ref": "#/definitions/PagingInfoModel", "description": "Paging data for given response" }, "sorting": { "description": "Sorting data for given response", "items": { "$ref": "#/definitions/SortFieldDto" }, "xml": { "name": "SortFieldDto", "wrapped": true }, "type": "array" } }, "xml": { "name": "PagedModel`1" }, "type": "object" }, "SimpleFilePublicLinkModel": { "properties": { "file": { "$ref": "#/definitions/PublicFileModel", "description": "File" }, "id": { "description": "Public link id", "type": "string" }, "url": { "description": "Public link url", "type": "string" }, "downloadLimit": { "description": "Download limit. Can be null", "type": "integer", "format": "int32" }, "downloadCount": { "description": "Download count", "type": "integer", "format": "int32" }, "creationDate": { "description": "Creation date", "type": "string" }, "expirationDate": { "description": "Expiration Date", "type": "string" }, "creator": { "$ref": "#/definitions/SimpleUserModel", "description": "User who created link" } }, "xml": { "name": "SimpleFilePublicLinkModel" }, "type": "object" }, "CreateFilePublicLinkModel": { "properties": { "downloadLimit": { "description": "Download limit. Can be null", "type": "integer", "format": "int32" }, "expirationValue": { "description": "Expiration value", "type": "string" }, "expirationType": { "description": "Expiration type", "type": "string", "enum": [ "Hour", "Day", "Week", "Month", "Date" ] } }, "xml": { "name": "CreateFilePublicLinkModel" }, "type": "object" }, "GetFileListRequest": { "properties": { "page": { "description": "Page number to display", "type": "integer", "format": "int32" }, "perPage": { "description": "Items per page in result collection; Default is 25", "type": "integer", "format": "int32" }, "sortField": { "description": "Name of field to sort the results by. (name, size, datetime, uploadstamp or path); Default is Path.", "type": "string" }, "sortDirection": { "description": "Sort direction; Default is ascending.", "type": "string" }, "newOnly": { "description": "Filter new files", "type": "boolean" }, "sinceDate": { "description": "Optional parameter if we want to filter files uploaded from the given date.\r\nDate should not be older than 7 days.", "type": "string" } }, "xml": { "name": "GetFileListRequest" }, "type": "object" }, "SimpleFileResourcePagedModel": { "properties": { "currentTimestamp": { "type": "string" }, "items": { "description": "Items on the given page", "items": { "$ref": "#/definitions/SimpleFileResourceModel" }, "readOnly": true, "xml": { "name": "SimpleFileResourceModel", "wrapped": true }, "type": "array" }, "paging": { "$ref": "#/definitions/PagingInfoModel", "description": "Paging data for given response" }, "sorting": { "description": "Sorting data for given response", "items": { "$ref": "#/definitions/SortFieldDto" }, "xml": { "name": "SortFieldDto", "wrapped": true }, "type": "array" } }, "xml": { "name": "SimpleFileResourcePagedModel" }, "type": "object" }, "SimpleFileResourceModel": { "description": "Container object used to provide information about a specific\r\nfile on a MOVEit Transfer server.", "properties": { "folderID": { "description": "ID of the folder this file is currently in.", "type": "integer", "format": "int32" }, "uploadUsername": { "description": "The username of the user account which uploaded this file.", "type": "string" }, "path": { "description": "The full path of this file.", "type": "string" }, "uploadStamp": { "description": "The date and time this file was uploaded.", "type": "string" }, "isNew": { "description": "Indicating whether the file is considered new for the current user", "type": "boolean" }, "name": { "description": "The name of this file.", "type": "string" }, "size": { "description": "Size in bytes of this file.", "type": "integer", "format": "int64" }, "id": { "description": "The unique ID of the file. Also known as the tracking number.", "type": "string" } }, "xml": { "name": "SimpleFileResourceModel" }, "type": "object" }, "GetFilesDetailedRequest": { "required": [ "pathMask", "fileMask" ], "properties": { "pathMask": { "description": "The path that may contain wildcards to specify the target directory for the search.\r\nFor example, \"home/user/*\" will search in any folder that matches this pattern under \"home/user\".", "type": "string" }, "fileMask": { "description": "An optional file mask used to filter the search results, such as \"*.pdf\" for text files.", "type": "string" }, "recursive": { "description": "Indicates whether the search should include files in subdirectories (recursive search).", "type": "boolean" }, "newOnly": { "description": "Determines whether only files that are new should be included in the results.", "type": "boolean" }, "sortField": { "description": "The field by which the search results should be sorted. \r\nAcceptable values include:\r\n- UploadStamp: Sort by the date and time the file was uploaded.\r\n- FileSize: Sort by the size of the file.\r\nIf an unsupported value is provided, the results will be sorted by the file path.", "type": "string" }, "sortDirection": { "description": "The order in which to sort the search results, \"asc\" for ascending or \"desc\" for descending.", "type": "string" }, "sinceDate": { "description": "The date used to filter results.", "type": "string" } }, "xml": { "name": "GetFilesDetailedRequest" }, "type": "object" }, "FileCopyMoveModel": { "properties": { "destinationFolderId": { "type": "string" } }, "xml": { "name": "FileCopyMoveModel" }, "type": "object" }, "DeleteFilePublicLinkRequest": { "properties": { "linkId": { "description": "Public Link Id", "type": "string" }, "id": { "description": "FileId", "type": "string" } }, "xml": { "name": "DeleteFilePublicLinkRequest" }, "type": "object" }, "GetSubfoldersListRequest": { "properties": { "id": { "description": "Parent Folder ID", "type": "integer", "format": "int32" }, "page": { "description": "Page number to display", "type": "integer", "format": "int32" }, "perPage": { "description": "Items per page in result collection; Default is 25", "type": "integer", "format": "int32" }, "sortField": { "description": "Field to sort by; Default is name.", "type": "string" }, "sortDirection": { "description": "Sort direction; Default is ascending.", "type": "string" }, "name": { "description": "Folder Name mask to search by", "type": "string" } }, "xml": { "name": "GetSubfoldersListRequest" }, "type": "object" }, "PagedModelOfSimpleFolderModel": { "description": "Represents paged response object with proper navigations", "properties": { "items": { "description": "Items on the given page", "items": { "$ref": "#/definitions/SimpleFolderModel" }, "readOnly": true, "xml": { "name": "SimpleFolderModel", "wrapped": true }, "type": "array" }, "paging": { "$ref": "#/definitions/PagingInfoModel", "description": "Paging data for given response" }, "sorting": { "description": "Sorting data for given response", "items": { "$ref": "#/definitions/SortFieldDto" }, "xml": { "name": "SortFieldDto", "wrapped": true }, "type": "array" } }, "xml": { "name": "PagedModel`1" }, "type": "object" }, "SimpleFolderModel": { "description": "Represents basic folder data required for all scenarios", "properties": { "id": { "description": "The unique ID of this folder.", "type": "integer", "format": "int32" }, "parentId": { "description": "The ID of this folder's parent folder or \"0\" if it does not have a parent folder.", "type": "integer", "format": "int32" }, "name": { "description": "The (short) name of this folder.", "type": "string" }, "lastContentChangeTime": { "description": "Last time the folder content changed", "type": "string" }, "folderType": { "description": "Indicates what kind of folder this is.", "type": "string", "enum": [ "Virtual", "Normal", "Archive", "Webpost", "GlobalMessaging", "Mailbox", "Root", "RootArchives", "RootWebposts" ] }, "path": { "description": "The (long) name of this folder.", "type": "string" }, "isShared": { "description": "Indicates whether this folder is shared with someone", "type": "boolean" }, "permission": { "$ref": "#/definitions/IFolderPermission", "description": "A MOVEit Permission describing the currently authorized user's permissions on this folder." }, "subfolderCount": { "description": "Number of subfolders in this folder", "type": "integer", "format": "int32" }, "totalFileCount": { "description": "Number of files in this folder", "type": "integer", "format": "int32" }, "sharedWithUsersCount": { "description": "Number of users this folder is shared with", "type": "integer", "format": "int32" }, "sharedWithGroupsCount": { "description": "Number of groups this folder is shared with", "type": "integer", "format": "int32" } }, "xml": { "name": "SimpleFolderModel" }, "type": "object" }, "IFolderPermission": { "description": "Represents folder permission object", "properties": { "canListSubfolders": { "description": "User can list the subfolders of a folder.", "readOnly": true, "type": "boolean" }, "canAddSubfolders": { "description": "User can add subfolders to the folder.", "readOnly": true, "type": "boolean" }, "canChangeSettings": { "description": "User can change the settings of the folder.", "readOnly": true, "type": "boolean" }, "canDelete": { "description": "User can delete the folder.", "readOnly": true, "type": "boolean" }, "canListFiles": { "description": "User can list the files in the folder.", "readOnly": true, "type": "boolean" }, "canReadFiles": { "description": "User can download the files in the folder.", "readOnly": true, "type": "boolean" }, "canWriteFiles": { "description": "User can upload files to the folder.", "readOnly": true, "type": "boolean" }, "canDeleteFiles": { "description": "User can delete files in the folder.", "readOnly": true, "type": "boolean" }, "canShare": { "description": "User can share files in the folder", "readOnly": true, "type": "boolean" } }, "xml": { "name": "IFolderPermission" }, "type": "object" }, "AddFolderModel": { "properties": { "name": { "description": "Folder name", "type": "string" }, "inheritPermissions": { "description": "Indicates how parent folder permissions should be inherited", "type": "string", "enum": [ "None", "CopyOnly", "Always" ] } }, "xml": { "name": "AddFolderModel" }, "type": "object" }, "FolderDetailsModel": { "description": "Represents a folder and all available attributes", "properties": { "orgId": { "description": "ID of the organization this folder exists in.", "type": "integer", "format": "int32" }, "owner": { "description": "The username of this folder's owner. (Home folders only)", "type": "string" }, "description": { "description": "Description of this folder.", "type": "string" }, "systemType": { "description": "Indicates if this folder is under the control of users or the MOVEit Transfer system.", "type": "string", "enum": [ "User", "System" ] }, "cleanType": { "description": "Describes what kind of automated clean up is regularly performed on this folder.", "type": "string", "enum": [ "Never", "AfterCleanTime" ] }, "cleanTimeDays": { "description": "Describes after how many days old files in this folder will be cleaned up.", "type": "integer", "format": "int32" }, "subfolderCleanTime": { "description": "Describes after how many days empty subfolders in this folder will be cleaned up.", "type": "integer", "format": "int32" }, "uploadNotificationConfirmationType": { "description": "Describes what kind of upload confirmation notifications are used in this folder.", "type": "string", "enum": [ "None", "Batch", "Immediately" ] }, "uploadNotificationConfirmationTime": { "description": "Describes how often batch notifications are sent.", "type": "integer", "format": "int32" }, "newFileNotificationType": { "description": "Describes what kind of new file notifications are used in this folder.", "type": "string", "enum": [ "None", "Batch", "Immediately" ] }, "newFileNotificationTime": { "description": "Describes how often new file batch notifications are sent.", "type": "integer", "format": "int32" }, "alertSenderFileIsNotDownloadedTimeType": { "description": "Describes the unit of measurement for notifying the sender when the files have not been downloaded.", "type": "string", "enum": [ "None", "Hours", "Days", "Minutes", "Immediately" ] }, "alertSenderFileIsNotDownloadedTime": { "description": "Describes after how many minutes, hours, days, depending on the value of {MOVEit.DMZ.WebApi.Models.Folders.FolderDetailsModel.AlertSenderFileIsNotDownloadedTimeType},\r\nthe sender will receive the notifiation that the sent files have not been downloaded.", "type": "integer", "format": "int32" }, "deliveryRecepientNotificationType": { "description": "Describes what kind of delivery recipient notifications are used in this folder.", "type": "string", "enum": [ "None", "Immediately" ] }, "responseType": { "description": "For webpost folders, the webpost completion and redirection setting.", "type": "string", "enum": [ "RedirectImmediately", "RedirectAfter" ] }, "responseText": { "description": "For webpost folders, text to display after a post to this folder.", "type": "string" }, "responseTime": { "description": "For webpost folders, the time after which redirection occurs.", "type": "integer", "format": "int32" }, "newTime": { "description": "The maximum amount of time, in days, that files in this folder are considered \"new\".", "type": "integer", "format": "int32" }, "enforceUniqueFilenames": { "description": "Indicates whether files in this folder must have unique names.", "type": "boolean" }, "allowFileOverwrite": { "description": "Indicates whether files of the same name will silently overwrite existing files of the same name.", "type": "boolean" }, "parentInheritRights": { "description": "Indicates whether the folder inherits its permissions from its parent folder.", "type": "integer", "format": "int32" }, "quota": { "description": "The folder quota, if any, in bytes.", "type": "integer", "format": "int64" }, "totalFilesSize": { "description": "The total size of all files in this folder (and subfolders if applicable), in bytes.", "type": "integer", "format": "int64" }, "fileMaskRule": { "description": "Indicates whether files uploaded to the folder that match the configured filemasks will be allowed or denied.", "type": "string", "enum": [ "AllowExceptMatching", "DenyExceptMatching" ] }, "fileMasks": { "description": "Comma-delimited list of filemasks which all files uploaded to the folder will be matched against.", "type": "string" }, "id": { "description": "The unique ID of this folder.", "type": "integer", "format": "int32" }, "parentId": { "description": "The ID of this folder's parent folder or \"0\" if it does not have a parent folder.", "type": "integer", "format": "int32" }, "name": { "description": "The (short) name of this folder.", "type": "string" }, "lastContentChangeTime": { "description": "Last time the folder content changed", "type": "string" }, "folderType": { "description": "Indicates what kind of folder this is.", "type": "string", "enum": [ "Virtual", "Normal", "Archive", "Webpost", "GlobalMessaging", "Mailbox", "Root", "RootArchives", "RootWebposts" ] }, "path": { "description": "The (long) name of this folder.", "type": "string" }, "isShared": { "description": "Indicates whether this folder is shared with someone", "type": "boolean" }, "permission": { "$ref": "#/definitions/IFolderPermission", "description": "A MOVEit Permission describing the currently authorized user's permissions on this folder." }, "subfolderCount": { "description": "Number of subfolders in this folder", "type": "integer", "format": "int32" }, "totalFileCount": { "description": "Number of files in this folder", "type": "integer", "format": "int32" }, "sharedWithUsersCount": { "description": "Number of users this folder is shared with", "type": "integer", "format": "int32" }, "sharedWithGroupsCount": { "description": "Number of groups this folder is shared with", "type": "integer", "format": "int32" } }, "xml": { "name": "FolderDetailsModel" }, "type": "object" }, "GetSubfilesListRequest": { "properties": { "id": { "description": "Parent Folder ID", "type": "integer", "format": "int32" }, "page": { "description": "Page number to display", "type": "integer", "format": "int32" }, "perPage": { "description": "Items per page in result collection; Default is 25", "type": "integer", "format": "int32" }, "sortField": { "description": "Field to sort by; Default is name.", "type": "string" }, "sortDirection": { "description": "Sort direction; Default is ascending.", "type": "string" }, "name": { "description": "File Name mask to search by", "type": "string" }, "newOnly": { "description": "Filter new files", "type": "boolean" } }, "xml": { "name": "GetSubfilesListRequest" }, "type": "object" }, "PagedModelOfSimpleFileResourceModel": { "description": "Represents paged response object with proper navigations", "properties": { "items": { "description": "Items on the given page", "items": { "$ref": "#/definitions/SimpleFileResourceModel" }, "readOnly": true, "xml": { "name": "SimpleFileResourceModel", "wrapped": true }, "type": "array" }, "paging": { "$ref": "#/definitions/PagingInfoModel", "description": "Paging data for given response" }, "sorting": { "description": "Sorting data for given response", "items": { "$ref": "#/definitions/SortFieldDto" }, "xml": { "name": "SortFieldDto", "wrapped": true }, "type": "array" } }, "xml": { "name": "PagedModel`1" }, "type": "object" }, "FolderUploadFileRequest": { "properties": { "uploadType": { "description": "Upload type", "type": "string" }, "id": { "description": "Folder ID", "type": "integer", "format": "int32" }, "pathHash": { "description": "File path hash for getting proper folder relations", "type": "string" } }, "xml": { "name": "FolderUploadFileRequest" }, "type": "object" }, "ResumableFileUploadModel": { "description": "Represents resumable file upload information after initial request", "properties": { "fileId": { "type": "string" }, "bytes": { "type": "integer", "format": "int64" }, "maxChunkSize": { "type": "integer", "format": "int64" } }, "xml": { "name": "ResumableFileUploadModel" }, "type": "object" }, "FolderContentRequest": { "properties": { "id": { "description": "Parent Folder ID", "type": "integer", "format": "int32" }, "pathHash": { "description": "Parent Folder path hash", "type": "string" }, "page": { "description": "Page number to display", "type": "integer", "format": "int32" }, "perPage": { "description": "Items per page in result collection; Default is 25", "type": "integer", "format": "int32" }, "sortField": { "description": "Field to sort by; (type, time, size or name); Sorting order starts with type and ends with name", "type": "string" }, "sortDirection": { "description": "Sort direction; Default is ascending.", "type": "string" }, "name": { "description": "Name mask to search by", "type": "string" } }, "xml": { "name": "FolderContentRequest" }, "type": "object" }, "PagedModelOfFolderContentItemModel": { "description": "Represents paged response object with proper navigations", "properties": { "items": { "description": "Items on the given page", "items": { "$ref": "#/definitions/FolderContentItemModel" }, "readOnly": true, "xml": { "name": "FolderContentItemModel", "wrapped": true }, "type": "array" }, "paging": { "$ref": "#/definitions/PagingInfoModel", "description": "Paging data for given response" }, "sorting": { "description": "Sorting data for given response", "items": { "$ref": "#/definitions/SortFieldDto" }, "xml": { "name": "SortFieldDto", "wrapped": true }, "type": "array" } }, "xml": { "name": "PagedModel`1" }, "type": "object" }, "FolderContentItemModel": { "description": "Represents information about items stored in folder.", "properties": { "id": { "description": "ID of the item.", "type": "integer", "format": "int32" }, "parentId": { "description": "The ID of the parent folder.", "type": "integer", "format": "int32" }, "type": { "description": "Content Type.", "type": "string", "enum": [ "Folder", "File" ] }, "name": { "description": "The name of this item.", "type": "string" }, "lastUpdateTime": { "description": "Last time this item changed", "type": "string" }, "path": { "description": "Path to this item.", "type": "string" }, "size": { "description": "Size of this item in bytes.", "type": "integer", "format": "int64" }, "folderType": { "description": "Indicates what kind of folder this is.", "type": "string", "enum": [ "Virtual", "Normal", "Archive", "Webpost", "GlobalMessaging", "Mailbox", "Root", "RootArchives", "RootWebposts" ] }, "isShared": { "description": "Indicates whether folder has been shared with someone.", "type": "boolean" } }, "xml": { "name": "FolderContentItemModel" }, "type": "object" }, "GetFolderListRequest": { "description": "Get all folders query", "properties": { "name": { "description": "File name mask for filtering list of Folders", "type": "string" }, "path": { "description": "File path mask for filtering list of Folders", "type": "string" }, "page": { "description": "Page number to display", "type": "integer", "format": "int32" }, "perPage": { "description": "Items per page in result collection; Default is 25", "type": "integer", "format": "int32" }, "sortField": { "description": "Name of field to sort the results by. (Name, Type or Path); Default is Path.", "type": "string" }, "sortDirection": { "description": "Sort direction; Default is ascending.", "type": "string" }, "sharedTo": { "items": { "type": "string" }, "type": "array" } }, "xml": { "name": "GetFolderListRequest" }, "type": "object" }, "GetFolderDetailsRequest": { "properties": { "skipCounts": { "description": "Whether to skip including counts of various folder properties like files\r\nand subfolders in the folder details results.", "type": "boolean" }, "skipFilesSize": { "description": "Whether to skip including total files size in a directory and its subdirectories(if any).", "type": "boolean" }, "id": { "description": "Folder ID", "type": "integer", "format": "int32" }, "pathHash": { "description": "File path hash for getting proper folder relations", "type": "string" } }, "xml": { "name": "GetFolderDetailsRequest" }, "type": "object" }, "FolderPatchModel": { "description": "Folder Update parameters.", "properties": { "name": { "description": "New file name to set.", "type": "string" }, "description": { "description": "New file description to set.", "type": "string" }, "inheritAccess": { "description": "Inherit Access From Parent.", "type": "boolean" } }, "xml": { "name": "FolderPatchModel" }, "type": "object" }, "FolderRequest": { "properties": { "id": { "description": "Folder ID", "type": "integer", "format": "int32" }, "pathHash": { "description": "File path hash for getting proper folder relations", "type": "string" } }, "xml": { "name": "FolderRequest" }, "type": "object" }, "FolderAclListRequest": { "properties": { "page": { "description": "Page number to display", "type": "integer", "format": "int32" }, "perPage": { "description": "Items per page in result collection; Default is 25", "type": "integer", "format": "int32" }, "sortField": { "description": "Field to sort by; Default is name.", "type": "string" }, "sortDirection": { "description": "Sort direction; Default is ascending.", "type": "string" }, "id": { "description": "Folder ID", "type": "integer", "format": "int32" }, "pathHash": { "description": "File path hash for getting proper folder relations", "type": "string" } }, "xml": { "name": "FolderAclListRequest" }, "type": "object" }, "PagedModelOfFolderAclEntryResourceModel": { "description": "Represents paged response object with proper navigations", "properties": { "items": { "description": "Items on the given page", "items": { "$ref": "#/definitions/FolderAclEntryResourceModel" }, "readOnly": true, "xml": { "name": "FolderAclEntryResourceModel", "wrapped": true }, "type": "array" }, "paging": { "$ref": "#/definitions/PagingInfoModel", "description": "Paging data for given response" }, "sorting": { "description": "Sorting data for given response", "items": { "$ref": "#/definitions/SortFieldDto" }, "xml": { "name": "SortFieldDto", "wrapped": true }, "type": "array" } }, "xml": { "name": "PagedModel`1" }, "type": "object" }, "FolderAclEntryResourceModel": { "description": "Represents folder Access Control List entry\r\nresource data suitable for output.", "properties": { "name": { "description": "Name of the entity referenced by the entry.", "type": "string" }, "type": { "description": "Type of the entry.", "type": "string", "enum": [ "None", "User", "Group", "Email" ] }, "id": { "description": "ID of the entity referenced by the entry.", "type": "string" }, "entryId": { "description": "ID of the access control entry.", "type": "string" }, "isHomeFolderUser": { "description": "Is home folder user permissions.", "type": "boolean" }, "isEditable": { "description": "Is permissions can be edited by the current user.", "type": "boolean" }, "isDeletable": { "description": "Is permissions can be deleted by the current user.", "type": "boolean" }, "permissions": { "$ref": "#/definitions/FolderAclPermissionsModel", "description": "Permissions set on the entry." } }, "xml": { "name": "FolderAclEntryResourceModel" }, "type": "object" }, "FolderAclPermissionsModel": { "properties": { "readFiles": { "type": "boolean" }, "writeFiles": { "type": "boolean" }, "deleteFiles": { "type": "boolean" }, "listFiles": { "type": "boolean" }, "notify": { "type": "boolean" }, "addDeleteSubfolders": { "type": "boolean" }, "share": { "type": "boolean" }, "sharePermissions": { "$ref": "#/definitions/FolderShareAclPermissionsModel" }, "admin": { "type": "boolean" }, "listUsers": { "type": "boolean" } }, "xml": { "name": "FolderAclPermissionsModel" }, "type": "object" }, "FolderShareAclPermissionsModel": { "properties": { "readFiles": { "type": "boolean" }, "writeFiles": { "type": "boolean" }, "deleteFiles": { "type": "boolean" }, "listFiles": { "type": "boolean" }, "notify": { "type": "boolean" }, "listUsers": { "type": "boolean" } }, "xml": { "name": "FolderShareAclPermissionsModel" }, "type": "object" }, "PutFolderAclEntryRequestModel": { "properties": { "overrideBehaviourType": { "description": "Permissions behavior. Works for home user permissions only. Default is OverrideInherited.", "type": "string", "enum": [ "AddToInherited", "OverrideInherited" ] }, "type": { "description": "Type of the entry.", "type": "string", "enum": [ "User", "Group" ] }, "id": { "description": "ID of the entity referenced by the entry.", "type": "string" }, "permissions": { "$ref": "#/definitions/FolderAclPermissionsModel", "description": "Permissions set on the entry." } }, "xml": { "name": "PutFolderAclEntryRequestModel" }, "type": "object" }, "SetFolderAclEntryRequestModel": { "properties": { "notificationMessage": { "description": "Optional notification message.", "type": "string" }, "type": { "description": "Type of the entry.", "type": "string", "enum": [ "User", "Group" ] }, "id": { "description": "ID of the entity referenced by the entry.", "type": "string" }, "permissions": { "$ref": "#/definitions/FolderAclPermissionsModel", "description": "Permissions set on the entry." } }, "xml": { "name": "SetFolderAclEntryRequestModel" }, "type": "object" }, "DeleteFolderAclEntryRequestModel": { "description": "Represents delete folder Access Control List entry\r\ndata suitable for use as user input.", "properties": { "type": { "description": "Type of the entry.", "type": "string", "enum": [ "User", "Group" ] }, "id": { "description": "ID of the entity referenced by the entry.", "type": "string" } }, "xml": { "name": "DeleteFolderAclEntryRequestModel" }, "type": "object" }, "FolderCopyMoveModel": { "properties": { "destinationFolderId": { "type": "integer", "format": "int32" } }, "xml": { "name": "FolderCopyMoveModel" }, "type": "object" }, "UpdateFolderFileMasksSettingsModel": { "properties": { "rule": { "type": "string", "enum": [ "AllowExceptMatching", "DenyExceptMatching" ] }, "masks": { "description": "List of filemasks.", "items": { "type": "string" }, "type": "array" }, "applyToSubfolders": { "description": "Apply changes to subfolders.", "type": "boolean" } }, "xml": { "name": "UpdateFolderFileMasksSettingsModel" }, "type": "object" }, "FolderFileMasksSettingsModel": { "description": "Represents folder filemasks settings.", "properties": { "rule": { "type": "string", "enum": [ "AllowExceptMatching", "DenyExceptMatching" ] }, "masks": { "description": "List of filemasks.", "items": { "type": "string" }, "type": "array" } }, "xml": { "name": "FolderFileMasksSettingsModel" }, "type": "object" }, "UpdateFolderMaintenanceSettingsModel": { "properties": { "folderCleanup": { "$ref": "#/definitions/FolderCleanup" }, "displayNewFilesForDays": { "type": "integer", "format": "int32" }, "folderQuota": { "$ref": "#/definitions/FolderQuota" }, "applyToSubfolders": { "description": "Apply changes to subfolders.", "type": "boolean" } }, "xml": { "name": "UpdateFolderMaintenanceSettingsModel" }, "type": "object" }, "FolderCleanup": { "properties": { "isCleanupEnabled": { "type": "boolean" }, "deleteOldFilesAfterDays": { "type": "integer", "format": "int32" }, "deleteEmptySubfoldersAfterDays": { "type": "integer", "format": "int32" } }, "xml": { "name": "FolderCleanup" }, "type": "object" }, "FolderQuota": { "properties": { "quota": { "type": "integer", "format": "int64" }, "quotaLevel": { "type": "string", "enum": [ "KB", "MB" ] }, "applyToFilesInSubfolders": { "type": "boolean" } }, "xml": { "name": "FolderQuota" }, "type": "object" }, "FolderMaintenanceSettingsModel": { "description": "Represents folder maintenance settings.", "properties": { "folderCleanup": { "$ref": "#/definitions/FolderCleanup" }, "displayNewFilesForDays": { "type": "integer", "format": "int32" }, "folderQuota": { "$ref": "#/definitions/FolderQuota" } }, "xml": { "name": "FolderMaintenanceSettingsModel" }, "type": "object" }, "UpdateFolderMiscellaneousSettingsModel": { "properties": { "hideHistory": { "type": "boolean" }, "createThumbnails": { "type": "boolean" }, "enforceUniqueFilenames": { "type": "boolean" }, "allowFileOverwrite": { "type": "boolean" }, "customSortField": { "type": "string", "enum": [ "None", "Name", "DateTime", "FileSize", "UploadUsername", "DownloadCount" ] }, "applyToSubfolders": { "description": "Apply changes to subfolders.", "type": "boolean" } }, "xml": { "name": "UpdateFolderMiscellaneousSettingsModel" }, "type": "object" }, "UpdateFolderNotificationSettingsModel": { "description": "Represents folder notification settings", "properties": { "notificationStyle": { "description": "The Notification Style setting determines whom notifications are sent to when a new file is uploaded.", "type": "string", "enum": [ "Normal", "InboxOutbox" ] }, "uploadConfirmationToSenderTime": { "description": "Upload Confirmation to Sender. Set -1 to turn off, 0 to send immediately or positive number (in minutes).", "type": "integer", "format": "int32" }, "newFileAlertToRecipientTime": { "description": "New File Alert to Recipient. Set -1 to turn off, 0 to send immediately or positive number (in minutes).", "type": "integer", "format": "int32" }, "deliveryReceiptToSender": { "description": "Delivery Receipt to Sender.", "type": "string", "enum": [ "None", "Immediately" ] }, "alertSenderFileIsNotDownloadedTime": { "description": "Alert Sender if File is Not Downloaded. Set -1 to turn off or positive number.", "type": "integer", "format": "int32" }, "alertSenderFileIsNotDownloadedTimeType": { "description": "Alert Sender if File is Not Downloaded time type. Used with \"DeliveryReceiptToSender\" set not to -1.", "type": "string", "enum": [ "Hours", "Days", "Minutes" ] }, "applyToSubfolders": { "description": "Apply changes to subfolders.", "type": "boolean" } }, "xml": { "name": "UpdateFolderNotificationSettingsModel" }, "type": "object" }, "FolderNotificationSettingsModel": { "description": "Represents folder update notification settings.", "properties": { "uploadConfirmationToSenderTime": { "type": "integer", "format": "int32" }, "newFileAlertToRecipientTime": { "type": "integer", "format": "int32" }, "deliveryReceiptToSender": { "type": "string", "enum": [ "None", "Hours", "Days", "Minutes", "Immediately" ] }, "alertSenderFileIsNotDownloadedTime": { "type": "integer", "format": "int32" }, "alertSenderFileIsNotDownloadedTimeType": { "type": "string", "enum": [ "None", "Hours", "Days", "Minutes", "Immediately" ] }, "notificationStyle": { "type": "string", "enum": [ "Normal", "InboxOutbox" ] } }, "xml": { "name": "FolderNotificationSettingsModel" }, "type": "object" }, "UpdateFolderAclEntryRequestModel": { "description": "Represents folder Access Control entry\r\ndata suitable for user input.", "properties": { "overrideBehaviourType": { "description": "Permissions behavior. Works for home user permissions only. Default is AddToInherited.", "type": "string", "enum": [ "AddToInherited", "OverrideInherited" ] }, "permissions": { "$ref": "#/definitions/FolderAclPermissionsModel", "description": "Permissions set on the entry." } }, "xml": { "name": "UpdateFolderAclEntryRequestModel" }, "type": "object" }, "UpdateFolderCharacterRestrictionsModel": { "description": "Represents folder character restrictions", "properties": { "charSet": { "description": "Character set.", "type": "string", "enum": [ "NoRestrictions", "WindowsNtfs", "CustomDisallow", "CustomAllow" ] }, "customCharSet": { "description": "Custom character set. Use with \"CustomDisallow\" or \"CustomAllow\" CharSet.", "type": "string" }, "replaceIllegalCharacters": { "description": "Replace illegal characters.", "type": "boolean" }, "replacementValue": { "description": "Automatically replace illegal characters with the value.\r\nUse the [CharID] macro to return the illegal character's hexadecimal code point value.", "type": "string" }, "applyToSubfolders": { "description": "Apply changes to subfolders.", "type": "boolean" } }, "xml": { "name": "UpdateFolderCharacterRestrictionsModel" }, "type": "object" }, "FolderCharacterRestrictionsModel": { "description": "Represents folder character restrictions.", "properties": { "charSet": { "description": "Character set.", "type": "string", "enum": [ "CheckParentFolder", "NoRestrictions", "WindowsNtfs", "CustomDisallow", "CustomAllow" ] }, "customCharSet": { "description": "Custom character set.", "type": "string" } }, "xml": { "name": "FolderCharacterRestrictionsModel" }, "type": "object" }, "GetGroupsListRequest": { "description": "Represents requred information in order to create a request to retreive list of groups.", "properties": { "page": { "description": "Page number to display", "type": "integer", "format": "int32" }, "perPage": { "description": "Items per page in result collection; Default is 25", "type": "integer", "format": "int32" } }, "xml": { "name": "GetGroupsListRequest" }, "type": "object" }, "PagedModelOfGroupModel": { "description": "Represents paged response object with proper navigations", "properties": { "items": { "description": "Items on the given page", "items": { "$ref": "#/definitions/GroupModel" }, "readOnly": true, "xml": { "name": "GroupModel", "wrapped": true }, "type": "array" }, "paging": { "$ref": "#/definitions/PagingInfoModel", "description": "Paging data for given response" }, "sorting": { "description": "Sorting data for given response", "items": { "$ref": "#/definitions/SortFieldDto" }, "xml": { "name": "SortFieldDto", "wrapped": true }, "type": "array" } }, "xml": { "name": "PagedModel`1" }, "type": "object" }, "GroupModel": { "description": "Represents group's requested information.", "properties": { "id": { "description": "Unique ID for this group.", "type": "integer", "format": "int32" }, "membersCount": { "description": "Amount of users, who are members of this particular group.", "type": "integer", "format": "int32" }, "name": { "description": "Name of the group.", "type": "string" }, "description": { "description": "Additional information, related to the group.", "type": "string" } }, "xml": { "name": "GroupModel" }, "type": "object" }, "BaseGroupModel": { "properties": { "name": { "description": "Name of the group.", "type": "string" }, "description": { "description": "Additional information, related to the group.", "type": "string" } }, "xml": { "name": "BaseGroupModel" }, "type": "object" }, "GetGroupMemberListRequest": { "properties": { "id": { "description": "Group ID", "type": "string" }, "page": { "description": "Page number to display", "type": "integer", "format": "int32" }, "perPage": { "description": "Items per page in result collection; Default is 25", "type": "integer", "format": "int32" } }, "xml": { "name": "GetGroupMemberListRequest" }, "type": "object" }, "PagedModelOfSimpleUserModel": { "description": "Represents paged response object with proper navigations", "properties": { "items": { "description": "Items on the given page", "items": { "$ref": "#/definitions/SimpleUserModel" }, "readOnly": true, "xml": { "name": "SimpleUserModel", "wrapped": true }, "type": "array" }, "paging": { "$ref": "#/definitions/PagingInfoModel", "description": "Paging data for given response" }, "sorting": { "description": "Sorting data for given response", "items": { "$ref": "#/definitions/SortFieldDto" }, "xml": { "name": "SortFieldDto", "wrapped": true }, "type": "array" } }, "xml": { "name": "PagedModel`1" }, "type": "object" }, "GroupAddMemberRequest": { "properties": { "id": { "description": "Group ID", "type": "string" }, "userIds": { "description": "List of user ids", "items": { "type": "string" }, "type": "array" } }, "xml": { "name": "GroupAddMemberRequest" }, "type": "object" }, "GroupRemoveMemberRequest": { "properties": { "id": { "description": "Group ID", "type": "string" }, "userId": { "description": "User ID", "type": "string" } }, "xml": { "name": "GroupRemoveMemberRequest" }, "type": "object" }, "LogRequest": { "properties": { "id": { "description": "Log ID", "type": "integer", "format": "int64" } }, "xml": { "name": "LogRequest" }, "type": "object" }, "LogDetailsModel": { "description": "Log Model that fully describes log entity", "properties": { "dlpMetadata": { "description": "DLP metadata", "type": "string" }, "webFarmNode": { "description": "Web farm node", "type": "integer", "format": "int32" }, "certificate": { "$ref": "#/definitions/Certificate", "description": "Certificate" }, "contentScannerName": { "description": "Content scanner name", "type": "string" }, "interfaceType": { "description": "Interface type", "type": "string" }, "parm1": { "description": "Parameter 1", "type": "string" }, "parm2": { "description": "Parameter 2", "type": "string" }, "parm3": { "description": "Parameter 3", "type": "string" }, "parm4": { "description": "Parameter 4", "type": "string" }, "id": { "description": "Log id", "type": "integer", "format": "int64" }, "logTime": { "description": "Log date and time", "type": "string" }, "uploadNotes": { "description": "Upload comment", "type": "string" }, "fileName": { "description": "Filename", "type": "string" }, "fileID": { "description": "File Id", "type": "string" }, "folderID": { "description": "Folder id", "type": "integer", "format": "int32" }, "folderPath": { "description": "Folder path", "type": "string" }, "virtualFolderID": { "description": "Virtual folder id", "type": "integer", "format": "int32" }, "virtualFolderPath": { "description": "Virtual folder path", "type": "string" }, "rate": { "description": "Rate", "type": "number", "format": "double" }, "duration": { "description": "Duration", "type": "number", "format": "double" }, "transferSize": { "description": "Transfer size", "type": "integer", "format": "int64" }, "username": { "description": "User id", "type": "string" }, "userLoginName": { "description": "User login name", "type": "string" }, "userFullName": { "description": "User fullname", "type": "string" }, "targetID": { "description": "Target id", "type": "string" }, "targetName": { "description": "Target name", "type": "string" }, "ipAddress": { "description": "IP Address", "type": "string" }, "action": { "description": "Log Action", "type": "string" }, "agentBrand": { "description": "Client brand", "type": "string" }, "agentVersion": { "description": "Client version", "type": "string" }, "message": { "description": "Log message", "type": "string" }, "errorCode": { "description": "Error code", "type": "integer", "format": "int32" }, "orgID": { "description": "Organization id", "type": "integer", "format": "int32" } }, "xml": { "name": "LogDetailsModel" }, "type": "object" }, "Certificate": { "properties": { "type": { "type": "string" }, "subject": { "type": "string" }, "cn": { "type": "string" }, "issuer": { "type": "string" }, "issuerCN": { "type": "string" }, "thumbprint": { "type": "string" }, "validAfter": { "type": "string" }, "validUntil": { "type": "string" }, "subjectAlternativeName": { "type": "string" }, "principalName": { "type": "string" }, "keyType": { "type": "string" }, "keyBits": { "type": "integer", "format": "int32" }, "fingerprints": { "additionalProperties": { "type": "string" }, "type": "object" } }, "xml": { "name": "Certificate" }, "type": "object" }, "GetLogsListRequest": { "properties": { "page": { "description": "Page number to display", "type": "integer", "format": "int32" }, "perPage": { "description": "Items per page in result collection; Default is 25", "type": "integer", "format": "int32" }, "sortField": { "description": "Name of field to sort the results by. (logtime, action, username, userrealname, targetname, filename, fileid, folderpath, xfersize, duration, rate, ipaddress, agentbrand, resilnode); Default is logtime.", "type": "string" }, "sortDirection": { "description": "Sort direction; Default is ascending.", "type": "string" }, "startDateTime": { "description": "Start Date/Time (MM-dd-yy, MM-dd-yyyy, MM-dd-yyyy HH:mm:ss, MM/dd/yyyy, MM/dd/yyyy HH:mm etc.)", "type": "string" }, "endDateTime": { "description": "End Date/Time (MM-dd-yy, MM-dd-yyyy, MM-dd-yyyy HH:mm:ss, MM/dd/yyyy, MM/dd/yyyy HH:mm etc.)", "type": "string" }, "action": { "description": "Name of action to filter by", "type": "string", "default": 0, "enum": [ "None", "FileTransfer", "Administration", "Upload", "Download", "UserMaintenance", "ContentScanning" ] }, "userNameContains": { "description": "Show usernames like this (For admin users only)", "type": "string" }, "userId": { "description": "Show only this user id (For admin users only. For non admin users current user ID is used.)", "type": "string" }, "fileIdContains": { "description": "Show file IDs like this", "type": "string" }, "fileNameContains": { "description": "Show file names like this", "type": "string" }, "sizeComparison": { "description": "File size comparison selection", "type": "string", "default": 0, "enum": [ "None", "LargerOrEqual", "SmallerOrEqual" ] }, "size": { "description": "File size (in KB)", "type": "string" }, "folderId": { "description": "Show only this Folder id", "type": "string" }, "folderPathContains": { "description": "Show folder path like this", "type": "string" }, "ipContains": { "description": "Show IP address like this", "type": "string" }, "agentBrandContains": { "description": "Show Agent Brand like this", "type": "string" }, "successFailure": { "description": "Filter Success/Errors", "type": "string", "default": 0, "enum": [ "None", "Success", "Error" ] }, "suppressSigns": { "description": "Suppress sign on/ sign off. Default is true", "type": "boolean" }, "suppressEmailNotes": { "description": "Suppress email notes. Default is true", "type": "boolean" }, "suppressLogViews": { "description": "Suppress log views. Default is true", "type": "boolean" } }, "xml": { "name": "GetLogsListRequest" }, "type": "object" }, "PagedModelOfSimpleLogModel": { "description": "Represents paged response object with proper navigations", "properties": { "items": { "description": "Items on the given page", "items": { "$ref": "#/definitions/SimpleLogModel" }, "readOnly": true, "xml": { "name": "SimpleLogModel", "wrapped": true }, "type": "array" }, "paging": { "$ref": "#/definitions/PagingInfoModel", "description": "Paging data for given response" }, "sorting": { "description": "Sorting data for given response", "items": { "$ref": "#/definitions/SortFieldDto" }, "xml": { "name": "SortFieldDto", "wrapped": true }, "type": "array" } }, "xml": { "name": "PagedModel`1" }, "type": "object" }, "SimpleLogModel": { "description": "Log Model that describes main log info", "properties": { "id": { "description": "Log id", "type": "integer", "format": "int64" }, "logTime": { "description": "Log date and time", "type": "string" }, "uploadNotes": { "description": "Upload comment", "type": "string" }, "fileName": { "description": "Filename", "type": "string" }, "fileID": { "description": "File Id", "type": "string" }, "folderID": { "description": "Folder id", "type": "integer", "format": "int32" }, "folderPath": { "description": "Folder path", "type": "string" }, "virtualFolderID": { "description": "Virtual folder id", "type": "integer", "format": "int32" }, "virtualFolderPath": { "description": "Virtual folder path", "type": "string" }, "rate": { "description": "Rate", "type": "number", "format": "double" }, "duration": { "description": "Duration", "type": "number", "format": "double" }, "transferSize": { "description": "Transfer size", "type": "integer", "format": "int64" }, "username": { "description": "User id", "type": "string" }, "userLoginName": { "description": "User login name", "type": "string" }, "userFullName": { "description": "User fullname", "type": "string" }, "targetID": { "description": "Target id", "type": "string" }, "targetName": { "description": "Target name", "type": "string" }, "ipAddress": { "description": "IP Address", "type": "string" }, "action": { "description": "Log Action", "type": "string" }, "agentBrand": { "description": "Client brand", "type": "string" }, "agentVersion": { "description": "Client version", "type": "string" }, "message": { "description": "Log message", "type": "string" }, "errorCode": { "description": "Error code", "type": "integer", "format": "int32" }, "orgID": { "description": "Organization id", "type": "integer", "format": "int32" } }, "xml": { "name": "SimpleLogModel" }, "type": "object" }, "GetMailboxListRequest": { "properties": {}, "xml": { "name": "GetMailboxListRequest" }, "type": "object" }, "MailboxModel": { "description": "Represents basic mailbox data required for all scenarios", "properties": { "id": { "description": "The unique ID of this mailbox.", "type": "string" }, "parentId": { "description": "The ID of this mailbox's parent folder or \"0\" if it does not have a parent mailbox.", "type": "string" }, "name": { "description": "The (short) name of this mailbox.", "type": "string" }, "lastContentChangeTime": { "description": "Last time the mailbox content changed", "type": "string" }, "folderType": { "description": "Indicates what kind of folder this is.", "type": "string", "enum": [ "Virtual", "Normal", "Archive", "Webpost", "GlobalMessaging", "Mailbox", "Root", "RootArchives", "RootWebposts" ] }, "path": { "description": "The (long) name of this mailbox.", "type": "string" }, "isShared": { "description": "Indicates whether this mailbox is shared with someone", "type": "boolean" }, "newPackagesCount": { "description": "Number of new packages", "type": "integer", "format": "int32" }, "allPackagesCount": { "description": "Number of all packages", "type": "integer", "format": "int32" }, "orderIndex": { "description": "Mailbox order index", "type": "integer", "format": "int32" }, "systemType": { "description": "Mailbox system type", "type": "integer", "format": "int32" }, "owner": { "description": "Mailbox owner username", "type": "string" }, "relationship": { "description": "Mailbox relationship", "type": "integer", "format": "int32" }, "ownerLoginName": { "description": "Mailbox owner login name", "type": "string" }, "ownerRealName": { "description": "Mailbox owner real name", "type": "string" } }, "xml": { "name": "MailboxModel" }, "type": "object" }, "SimplePackageModel": { "description": "Represents basic package data required for all scenarios", "properties": { "toRecipients": { "description": "List of To recipients", "items": { "type": "string" }, "type": "array" }, "id": { "description": "Package id. The value is null for action operations", "type": "integer", "format": "int32" }, "orgId": { "description": "Organization id", "type": "integer", "format": "int32" }, "mailboxId": { "description": "Mailbox id", "type": "string" }, "sendStamp": { "description": "Mailbox time stamp", "type": "string" }, "parentId": { "description": "Parent id", "type": "string" }, "deliveryReceipts": { "description": "Delivery receipts", "type": "boolean" }, "expirationHours": { "description": "Expiration hours", "type": "integer", "format": "int32" }, "recalled": { "description": "True if package is recalled", "type": "boolean" }, "isNew": { "description": "True if package is new", "type": "boolean" }, "subject": { "description": "Package subject", "type": "string" }, "sender": { "$ref": "#/definitions/SimpleUserModel", "description": "Sender info" }, "composerType": { "description": "Composer package type", "type": "string", "enum": [ "General", "Request" ] }, "dlpViolation": { "description": "File DLP violation info", "type": "string" }, "dlpBlocked": { "description": "When true, the package contains DLP violations that prevent it from being downloaded, according to currently configured DLP rules.", "type": "boolean" }, "packageClassificationType": { "$ref": "#/definitions/SimplePackageClassificationTypeModel", "description": "Package classification type" }, "readStatus": { "description": "Package read status", "type": "string", "enum": [ "None", "Some", "All" ] } }, "xml": { "name": "SimplePackageModel" }, "type": "object" }, "SimplePackageClassificationTypeModel": { "properties": { "id": { "description": "Gets or sets id of classification type", "type": "integer", "format": "int32" }, "value": { "description": "Gets or sets value of classification type", "type": "string" } }, "xml": { "name": "SimplePackageClassificationTypeModel" }, "type": "object" }, "PackageMovePatchModel": { "description": "Package Update parameters", "properties": { "packageId": { "description": "New package mailbox to set", "type": "string" }, "mailboxId": { "description": "Source Mailbox Id", "type": "string" } }, "xml": { "name": "PackageMovePatchModel" }, "type": "object" }, "PackageDetailsModel": { "description": "Represents a package and all available attributes", "properties": { "isSecureBody": { "description": "If true body is secured", "type": "boolean" }, "attachments": { "description": "List of attachments", "items": { "$ref": "#/definitions/SimpleFileResourceModel" }, "xml": { "name": "SimpleFileResourceModel", "wrapped": true }, "type": "array" }, "body": { "description": "Package body", "type": "string" }, "maxAttachDownloads": { "description": "Maximum downloads of attachment", "type": "integer", "format": "int32" }, "recipients": { "description": "List of recipients", "items": { "$ref": "#/definitions/Recipient" }, "xml": { "name": "Recipient", "wrapped": true }, "type": "array" }, "noReply": { "description": "Used to prevent reply", "type": "string", "enum": [ "AllowAll", "DenyReplyAll", "DenyAllReplies" ] }, "id": { "description": "Package id. The value is null for action operations", "type": "integer", "format": "int32" }, "orgId": { "description": "Organization id", "type": "integer", "format": "int32" }, "mailboxId": { "description": "Mailbox id", "type": "string" }, "sendStamp": { "description": "Mailbox time stamp", "type": "string" }, "parentId": { "description": "Parent id", "type": "string" }, "deliveryReceipts": { "description": "Delivery receipts", "type": "boolean" }, "expirationHours": { "description": "Expiration hours", "type": "integer", "format": "int32" }, "recalled": { "description": "True if package is recalled", "type": "boolean" }, "isNew": { "description": "True if package is new", "type": "boolean" }, "subject": { "description": "Package subject", "type": "string" }, "sender": { "$ref": "#/definitions/SimpleUserModel", "description": "Sender info" }, "composerType": { "description": "Composer package type", "type": "string", "enum": [ "General", "Request" ] }, "dlpViolation": { "description": "File DLP violation info", "type": "string" }, "dlpBlocked": { "description": "When true, the package contains DLP violations that prevent it from being downloaded, according to currently configured DLP rules.", "type": "boolean" }, "packageClassificationType": { "$ref": "#/definitions/SimplePackageClassificationTypeModel", "description": "Package classification type" }, "readStatus": { "description": "Package read status", "type": "string", "enum": [ "None", "Some", "All" ] } }, "xml": { "name": "PackageDetailsModel" }, "type": "object" }, "Recipient": { "properties": { "type": { "description": "Recipient type", "type": "string", "enum": [ "User", "Group", "Unreg", "Unverified" ] }, "role": { "description": "Recipient role", "type": "string", "enum": [ "To", "CC", "BCC" ] }, "identifier": { "description": "Recipient identifier", "type": "string" }, "name": { "description": "Recipient name (read only)", "type": "string" } }, "xml": { "name": "Recipient" }, "type": "object" }, "PackageMailboxActionModel": { "properties": { "packageId": { "description": "Package id", "type": "string" }, "id": { "description": "Mailbox id", "type": "string" }, "action": { "description": "Package action (Reply, ReplyAll, Forward, Resend)", "type": "string" } }, "xml": { "name": "PackageMailboxActionModel" }, "type": "object" }, "PackagePatchModel": { "description": "Package Update parameters", "properties": { "recalled": { "description": "Set true to recall the package", "type": "boolean" }, "isNew": { "description": "IsNew to set", "type": "boolean" } }, "xml": { "name": "PackagePatchModel" }, "type": "object" }, "LogsSettingsUpdateRequest": { "properties": { "logRetention": { "description": "Logs are retained ONLINE for a fixed number of days. After this period passes, logs are collected and saved as XML documents in the LOGS folder.\r\nNOTE: This value must be greater than or equal to the current Delete User After Expiration value.", "type": "integer", "format": "int32" }, "archiveLogs": { "description": "Archive old log entries to /Archive/Logs before deleting.", "type": "boolean" } }, "xml": { "name": "LogsSettingsUpdateRequest" }, "type": "object" }, "LogsSettingsModel": { "description": "Represents audit logs settings.", "properties": { "logRetention": { "description": "Logs are retained ONLINE for a fixed number of days. After this period passes, logs are collected and saved as XML documents in the LOGS folder.\r\nNOTE: This value must be greater than or equal to the current Delete User After Expiration value.", "type": "integer", "format": "int32" }, "archiveLogs": { "description": "Archive old log entries to /Archive/Logs before deleting.", "type": "boolean" } }, "xml": { "name": "LogsSettingsModel" }, "type": "object" }, "OrgDetailedModel": { "description": "Detailed information about organization", "properties": { "shortName": { "description": "Organization short name", "type": "string" }, "language": { "description": "Organization language", "type": "string" }, "formattingLocale": { "description": "A Locale which is used for formatting dates and times in this organization.", "type": "string" }, "securityBanner": { "description": "Organization security banner in default language", "type": "string" }, "securityNotice": { "description": "Organization security notice in default language", "type": "string" }, "securityNoticeStamp": { "description": "Organization security notice change stamp", "type": "string" }, "securityNoticeRequired": { "description": "Organization security notice requirement setting", "type": "string", "enum": [ "NotRequired", "WhenNew", "Always" ] }, "techInfo": { "description": "Organization tech support notice in default language", "type": "string" }, "techName": { "description": "Organization tech support name in default language", "type": "string" }, "techPhone": { "description": "Organization tech support phone in default language", "type": "string" }, "techEmail": { "description": "Organization tech support email in default language", "type": "string" }, "informationLink": { "description": "Organization information link in default language", "type": "string" }, "informationLinkName": { "description": "Organization information link name in default language", "type": "string" }, "contactLink": { "description": "Organization contact link in default language", "type": "string" }, "contactLinkName": { "description": "Organization contact link name in default language", "type": "string" }, "allowPassChangeRequests": { "description": "Organization allow password change requirement setting", "type": "boolean" }, "baseURL": { "description": "Organization base URL", "type": "string" }, "notes": { "description": "Organization notes", "type": "string" }, "id": { "description": "Organization Id", "type": "string" }, "name": { "description": "Organization name", "type": "string" }, "usersCount": { "description": "Number of users in organization", "type": "integer", "format": "int32" }, "foldersCount": { "description": "Number of users in organization", "type": "integer", "format": "int32" }, "filesCount": { "description": "Number of users in organization", "type": "integer", "format": "int32" } }, "xml": { "name": "OrgDetailedModel" }, "type": "object" }, "GetOrgListRequest": { "properties": { "page": { "description": "Page number to display", "type": "integer", "format": "int32" }, "perPage": { "description": "Items per page in result collection; Default is 25", "type": "integer", "format": "int32" }, "sortField": { "description": "Name of field to sort the results by. (name, id); Default is Name.", "type": "string" }, "sortDirection": { "description": "Sort direction; Default is ascending.", "type": "string" } }, "xml": { "name": "GetOrgListRequest" }, "type": "object" }, "PagedModelOfSimpleOrgModel": { "description": "Represents paged response object with proper navigations", "properties": { "items": { "description": "Items on the given page", "items": { "$ref": "#/definitions/SimpleOrgModel" }, "readOnly": true, "xml": { "name": "SimpleOrgModel", "wrapped": true }, "type": "array" }, "paging": { "$ref": "#/definitions/PagingInfoModel", "description": "Paging data for given response" }, "sorting": { "description": "Sorting data for given response", "items": { "$ref": "#/definitions/SortFieldDto" }, "xml": { "name": "SortFieldDto", "wrapped": true }, "type": "array" } }, "xml": { "name": "PagedModel`1" }, "type": "object" }, "SimpleOrgModel": { "properties": { "id": { "description": "Organization Id", "type": "string" }, "name": { "description": "Organization name", "type": "string" }, "usersCount": { "description": "Number of users in organization", "type": "integer", "format": "int32" }, "foldersCount": { "description": "Number of users in organization", "type": "integer", "format": "int32" }, "filesCount": { "description": "Number of users in organization", "type": "integer", "format": "int32" } }, "xml": { "name": "SimpleOrgModel" }, "type": "object" }, "OrgAddModel": { "description": "Represents data required for create organization scenario", "required": [ "name", "passPhrase" ], "properties": { "name": { "description": "Organization name.", "type": "string" }, "shortName": { "description": "Organization short name.", "type": "string" }, "passPhrase": { "description": "Organization pass phrase.", "type": "string" }, "techName": { "description": "Organization tech contact name.", "type": "string" }, "techPhone": { "description": "Organization tech phone.", "type": "string" }, "techEmail": { "description": "Organization tech email.", "type": "string" } }, "xml": { "name": "OrgAddModel" }, "type": "object" }, "OrgMaxUserCountsModel": { "description": "Represents maximum user counts for an organization.", "properties": { "totalUsers": { "description": "Defines the total number of users that may be created in the Organization, including Admins of all types, End Users, and Temporary Users.\r\nSet to \"0\" for no organization level Maximum Total Users.\r\nMay not exceed the \"system Maximum User Count\", which is the maximum number of users licensed.", "type": "integer", "format": "int32" }, "endUsers": { "description": "Defines the total number of End Users that may be created in the Organization.\r\nSet to \"0\" for no organization level Maximum End Users.\r\nMay not exceed the Maximum Total Users if that number is set to something other than 0.\r\nMay not exceed the \"system Maximum User Count\", which is the maximum number of users licensed.\r\nNote: The sum of Maximum End Users and Maximum Temporary Users is allowed exceed the Total Maximum Users.", "type": "integer", "format": "int32" }, "tempUsers": { "description": "Defines the total number of Temporary Users that may be created in the Organization.\r\nSet to \"0\" for no organization level Maximum Temp Users.\r\nMay not exceed the Maximum Total Users if that number is set to something other than 0.\r\nNote: If the Maximum Total Users is set to 0, the Maximum Temp Users is allowed to exceed the \"system Maximum User Count\" (and will, in fact, not be capped by the system Maximum User Count).", "type": "integer", "format": "int32" } }, "xml": { "name": "OrgMaxUserCountsModel" }, "type": "object" }, "OrgPackageAccessUpdateModel": { "description": "Represents administrator package access settings update model for an organization.", "properties": { "applyToAllOrganizations": { "description": "In the case of an update system organization by sysadmin the settings could apply to all other organizations.\r\nDefault is false.", "type": "boolean" }, "showAdHocTransferEntriesInLog": { "description": "This setting, when enabled, allows audit log entries related to Ad Hoc Transfer to be shown in the main Logs page.\r\nThis allows administrators to see all Ad Hoc Transfer related log entries in an organization.\r\nDefault is false.", "type": "boolean" }, "adminPackageAccess": { "description": "This setting, when enabled, allows administrators to view the mailboxes and packages for users under their control, and download any attachments associated with those packages.\r\nIn addition, this setting allows administrators to enable shared mailboxes for users.\r\nViewing a package or downloading an attachment will be audit logged and visible to the user, though no viewing or download limits will be affected.\r\nDefault is None.", "type": "string", "enum": [ "None", "AdminOnly", "AdminAndGroupAdmin" ] } }, "xml": { "name": "OrgPackageAccessUpdateModel" }, "type": "object" }, "OrgPackageAccessModel": { "description": "Represents administrator package access settings for an organization.", "properties": { "showAdHocTransferEntriesInLog": { "description": "This setting, when enabled, allows audit log entries related to Ad Hoc Transfer to be shown in the main Logs page.\r\nThis allows administrators to see all Ad Hoc Transfer related log entries in an organization.\r\nDefault is false.", "type": "boolean" }, "adminPackageAccess": { "description": "This setting, when enabled, allows administrators to view the mailboxes and packages for users under their control, and download any attachments associated with those packages.\r\nIn addition, this setting allows administrators to enable shared mailboxes for users.\r\nViewing a package or downloading an attachment will be audit logged and visible to the user, though no viewing or download limits will be affected.\r\nDefault is None.", "type": "string", "enum": [ "None", "AdminOnly", "AdminAndGroupAdmin" ] } }, "xml": { "name": "OrgPackageAccessModel" }, "type": "object" }, "OrgAdminPasswordResetSettingsModel": { "description": "Represents administrator password reset settings for an organization.", "properties": { "enableAdminPasswordReset": { "description": "Enable/disable administrators to reset their own password.\r\nDefault is false.", "type": "boolean" } }, "xml": { "name": "OrgAdminPasswordResetSettingsModel" }, "type": "object" }, "OrgUiConfigurationModel": { "description": "Represents user interface configuration", "properties": { "showFileAndFolder": { "description": "Show file and folder options", "type": "boolean" }, "showAdHocPackage": { "description": "Show ad hoc package options", "type": "boolean" }, "showSecureFolderSharing": { "description": "Show secure folder sharing options (Could be enabled with ShowFileAndFolder option enabled only)", "type": "boolean" } }, "xml": { "name": "OrgUiConfigurationModel" }, "type": "object" }, "OrgPatchModel": { "properties": { "name": { "description": "Organization name.", "type": "string" }, "shortName": { "description": "Organization short name.", "type": "string" }, "baseUrl": { "description": "Organization base URL.", "type": "string" }, "notes": { "description": "Organization notes.", "type": "string" } }, "xml": { "name": "OrgPatchModel" }, "type": "object" }, "PackageListRequest": { "properties": { "page": { "description": "Page number to display", "type": "integer", "format": "int32" }, "perPage": { "description": "Items per page in result collection; Default is 25", "type": "integer", "format": "int32" }, "sortField": { "description": "Name of field to sort the results by. (sendStamp); Default is sendStamp.", "type": "string" }, "sortDirection": { "description": "Sort direction; Default is ascending.", "type": "string" }, "newOnly": { "description": "Filter new files", "type": "boolean" }, "sentTo": { "description": "Filter by recipients", "items": { "type": "string" }, "type": "array" }, "receivedFrom": { "description": "Filter by senders", "items": { "type": "string" }, "type": "array" }, "mailboxId": { "description": "Filter by mailbox ID", "type": "string" } }, "xml": { "name": "PackageListRequest" }, "type": "object" }, "PagedModelOfSimplePackageModel": { "description": "Represents paged response object with proper navigations", "properties": { "items": { "description": "Items on the given page", "items": { "$ref": "#/definitions/SimplePackageModel" }, "readOnly": true, "xml": { "name": "SimplePackageModel", "wrapped": true }, "type": "array" }, "paging": { "$ref": "#/definitions/PagingInfoModel", "description": "Paging data for given response" }, "sorting": { "description": "Sorting data for given response", "items": { "$ref": "#/definitions/SortFieldDto" }, "xml": { "name": "SortFieldDto", "wrapped": true }, "type": "array" } }, "xml": { "name": "PagedModel`1" }, "type": "object" }, "CreatePackageRequestModel": { "properties": { "attachments": { "description": "List of file IDs", "items": { "$ref": "#/definitions/FileIdModel" }, "xml": { "name": "FileIdModel", "wrapped": true }, "type": "array" }, "body": { "description": "Note of the package", "type": "string" }, "deliveryReceipts": { "description": "Delivery receipts", "type": "boolean" }, "expirationHours": { "description": "Expiration hours", "type": "integer", "format": "int32" }, "maxAttachDownloads": { "description": "Maximum downloads of attachments", "type": "integer", "format": "int32" }, "noReply": { "description": "Used to prevent reply", "type": "string", "enum": [ "AllowAll", "DenyReplyAll", "DenyAllReplies" ] }, "recipients": { "description": "List of recipients", "items": { "$ref": "#/definitions/Recipient" }, "xml": { "name": "Recipient", "wrapped": true }, "type": "array" }, "recipToList": { "description": "Recipients To list", "items": { "type": "string" }, "type": "array" }, "recipCCList": { "description": "Recipients CC list", "items": { "type": "string" }, "type": "array" }, "recipBCCList": { "description": "Recipients BCC list", "items": { "type": "string" }, "type": "array" }, "type": { "description": "Package type. Use Draft or template for saving package and General for sending package.", "type": "string", "enum": [ "General", "Draft", "Template" ] }, "composerType": { "description": "Composer package type. Use Request for requesting files.", "type": "string", "enum": [ "General", "Request" ] }, "subject": { "description": "Subject of package. Required", "type": "string" }, "parentId": { "description": "Parent ID", "type": "string" }, "isSecureBody": { "description": "Set true to secure package body", "type": "boolean" }, "derivativeId": { "description": "Derivative ID. Use to delete draft", "type": "string" }, "packageClassificationTypeId": { "description": "Package Classification Type ID", "type": "integer", "format": "int32" }, "skipNotifyFromTransfer": { "description": "Send notification from Transfer (true if being sent from Outlook)", "type": "boolean" } }, "xml": { "name": "CreatePackageRequestModel" }, "type": "object" }, "FileIdModel": { "description": "File id model.", "properties": { "id": { "description": "The unique ID of the file. Also known as the tracking number.", "type": "string" } }, "xml": { "name": "FileIdModel" }, "type": "object" }, "PackageRequirementsModel": { "properties": { "allowSendPackages": { "description": "Whether the user is allowed to send packages at all.", "type": "boolean" }, "allowAttachFiles": { "description": "Whether the user is allowed to attach files to packages.", "type": "boolean" }, "defaultUserPackageExpirationHours": { "description": "Value in hours which users can set specific expirations on their packages.\r\n-1 if not allowed.", "type": "integer", "format": "int32" }, "maxUserPackageExpirationHours": { "description": "Number of hours after packages expire and delete.\r\n-1 if not applied.", "type": "integer", "format": "int32" }, "defaultAttachmentDownloads": { "description": "Default download limit on user's packages which users can modify.\r\n-1 if not applied.", "type": "integer", "format": "int32" }, "maxAttachmentDownloads": { "description": "Number that specifies a download limit of a file from any package.\r\n-1 if not applied.", "type": "integer", "format": "int32" }, "maxFilesPerPackageLimit": { "description": "Number that specifies a maximum number of files per package.\r\n-1 if the user is not authorized.", "type": "integer", "format": "int32" }, "defaultSecureNote": { "description": "Whether the Secure The Note setting is enabled by default.", "type": "boolean" }, "allowChangeSecureNote": { "description": "Whether the user is allowed to change the Secure The Note setting value.", "type": "boolean" }, "isClassificationFieldRequired": { "description": "Gets or sets is classification type required", "type": "boolean" }, "classificationTypes": { "description": "Gets or sets classification types list", "items": { "$ref": "#/definitions/PackageClassificationTypeModel" }, "xml": { "name": "PackageClassificationTypeModel", "wrapped": true }, "type": "array" } }, "xml": { "name": "PackageRequirementsModel" }, "type": "object" }, "PackageClassificationTypeModel": { "properties": { "orderIndex": { "description": "Gets or sets order of classification types", "type": "integer", "format": "int32" }, "id": { "description": "Gets or sets id of classification type", "type": "integer", "format": "int32" }, "value": { "description": "Gets or sets value of classification type", "type": "string" } }, "xml": { "name": "PackageClassificationTypeModel" }, "type": "object" }, "PackageRequest": { "properties": { "id": { "description": "Package id", "type": "string" }, "mailboxId": { "description": "Mailbox id", "type": "string" } }, "xml": { "name": "PackageRequest" }, "type": "object" }, "CollectionModelOfRecipientListItem": { "description": "Represents a collection of resources", "properties": { "items": { "description": "Items on the given page", "items": { "$ref": "#/definitions/RecipientListItem" }, "readOnly": true, "xml": { "name": "RecipientListItem", "wrapped": true }, "type": "array" } }, "xml": { "name": "CollectionModel`1" }, "type": "object" }, "RecipientListItem": { "description": "Expansion of the {MOVEit.DMZ.Application.Contracts.Packages.Recipient.Recipient} class for use with detailed recipient lists,\r\nsuch as for a view status list or send receipt.", "properties": { "viewStatus": { "description": "View status for the recipient for a given package.", "type": "string", "enum": [ "None", "Some", "All" ] }, "password": { "description": "Password of the recipient.", "type": "string" }, "allowChildExpansion": { "description": "Whether child entries of the recipient should be shown.", "type": "boolean" }, "children": { "description": "Child entries of the recipient.", "items": { "$ref": "#/definitions/RecipientListItem" }, "xml": { "name": "RecipientListItem", "wrapped": true }, "type": "array" }, "type": { "description": "Recipient type", "type": "string", "enum": [ "User", "Group", "Unreg", "Unverified" ] }, "role": { "description": "Recipient role", "type": "string", "enum": [ "To", "CC", "BCC" ] }, "identifier": { "description": "Recipient identifier", "type": "string" }, "name": { "description": "Recipient name (read only)", "type": "string" } }, "xml": { "name": "RecipientListItem" }, "type": "object" }, "PackageActionRequest": { "properties": { "action": { "description": "Package action (Reply, ReplyAll, Forward, Resend)", "type": "string" }, "id": { "description": "Package id", "type": "string" }, "mailboxId": { "description": "Mailbox id", "type": "string" } }, "xml": { "name": "PackageActionRequest" }, "type": "object" }, "PackageNotificationRequest": { "properties": { "includeImages": { "type": "boolean" }, "id": { "description": "Package id", "type": "string" }, "mailboxId": { "description": "Mailbox id", "type": "string" } }, "xml": { "name": "PackageNotificationRequest" }, "type": "object" }, "NotificationModel": { "properties": { "subject": { "description": "Notification subject", "type": "string" }, "body": { "description": "Main notification body", "type": "string" }, "isHtml": { "description": "Whether the main notification body is HTML-formatted", "type": "boolean" }, "alternateBody": { "description": "Alternate text-formatted body if the main body is HTML-formatted", "type": "string" }, "inlineAttachments": { "description": "Collection of inline attachments to include with notification", "items": { "$ref": "#/definitions/InlineAttachment" }, "xml": { "name": "InlineAttachment", "wrapped": true }, "type": "array" } }, "xml": { "name": "NotificationModel" }, "type": "object" }, "InlineAttachment": { "description": "Data class defining an inline attachment used in a notification message.", "properties": { "filename": { "description": "Name of attachment file; this will also be the content ID value used to reference the attachment in the notification message body", "type": "string" }, "base64Content": { "description": "Base64-encoded content of the attachment", "type": "string" } }, "xml": { "name": "InlineAttachment" }, "type": "object" }, "AttachmentRequest": { "properties": { "id": { "description": "File ID", "type": "string" } }, "xml": { "name": "AttachmentRequest" }, "type": "object" }, "PublicOrgModel": { "description": "Represents organization data required for all scenarios", "properties": { "id": { "description": "Organization Id.", "type": "string" }, "name": { "description": "Organization name.", "type": "string" }, "shortName": { "description": "Organization short name.", "type": "string" }, "language": { "description": "Organization language.", "type": "string" }, "formattingLocale": { "description": "A Locale which is used for formatting dates and times in this organization.", "type": "string" }, "securityBanner": { "description": "Organization security banner in default language.", "type": "string" }, "securityNotice": { "description": "Organization security notice in default language.", "type": "string" }, "securityNoticeStamp": { "description": "Organization security notice change stamp.", "type": "string" }, "securityNoticeRequired": { "description": "Organization security notice requirement setting.", "type": "string", "enum": [ "NotRequired", "WhenNew", "Always" ] }, "securityNoticeAcceptance": { "description": "Organization security acceptance notice in default language.", "type": "string" }, "techInfo": { "description": "Organization tech support notice in default language.", "type": "string" }, "techName": { "description": "Organization tech support name in default language.", "type": "string" }, "techPhone": { "description": "Organization tech support phone in default language.", "type": "string" }, "techEmail": { "description": "Organization tech support email in default language.", "type": "string" }, "informationLink": { "description": "Organization information link in default language.", "type": "string" }, "informationLinkName": { "description": "Organization information link name in default language.", "type": "string" }, "contactLink": { "description": "Organization contact link in default language.", "type": "string" }, "contactLinkName": { "description": "Organization contact link name in default language.", "type": "string" }, "allowPassChangeRequests": { "description": "Organization allow password change requirement setting.", "type": "boolean" }, "baseURL": { "description": "Organization base URL.", "type": "string" }, "mfaTrustDeviceEnabled": { "description": "Defines if trust device functionality is enabled during mfa flow.", "type": "boolean" }, "ssoAuthMode": { "description": "Defines SSO authentication mode.", "type": "string", "enum": [ "Invalid", "Optional", "Required" ] }, "samlAuthMode": { "readOnly": true, "type": "string" } }, "xml": { "name": "PublicOrgModel" }, "type": "object" }, "ReportDownloadRequest": { "properties": { "format": { "description": "Report output format. If value is null, the default report format is used.", "type": "string", "enum": [ "XML", "CSV", "HTMLNAKED", "HTMLSTYLED", "Unknown" ] }, "id": { "description": "Report Id", "type": "integer", "format": "int32" } }, "xml": { "name": "ReportDownloadRequest" }, "type": "object" }, "ReportListRequest": { "properties": { "page": { "description": "Page number to display", "type": "integer", "format": "int32" }, "perPage": { "description": "Items per page in result collection; Default is 25", "type": "integer", "format": "int32" }, "sortField": { "description": "Name of field to sort the results by. (title); Default is title.", "type": "string" }, "sortDirection": { "description": "Sort direction; Default is ascending.", "type": "string" } }, "xml": { "name": "ReportListRequest" }, "type": "object" }, "PagedModelOfSimpleReportModel": { "description": "Represents paged response object with proper navigations", "properties": { "items": { "description": "Items on the given page", "items": { "$ref": "#/definitions/SimpleReportModel" }, "readOnly": true, "xml": { "name": "SimpleReportModel", "wrapped": true }, "type": "array" }, "paging": { "$ref": "#/definitions/PagingInfoModel", "description": "Paging data for given response" }, "sorting": { "description": "Sorting data for given response", "items": { "$ref": "#/definitions/SortFieldDto" }, "xml": { "name": "SortFieldDto", "wrapped": true }, "type": "array" } }, "xml": { "name": "PagedModel`1" }, "type": "object" }, "SimpleReportModel": { "description": "Simple report model.", "properties": { "id": { "description": "Report Id.", "type": "integer", "format": "int32" }, "title": { "description": "Report name.", "type": "string" }, "category": { "description": "Report category.", "type": "string", "enum": [ "FileTransfer", "AdHocTransfer", "Storage", "UserMaintenance", "UserStatus", "Security", "Performance", "ContentScanning", "System", "Custom", "Default", "Unknown" ] } }, "xml": { "name": "SimpleReportModel" }, "type": "object" }, "EmptyRequest": { "properties": {}, "xml": { "name": "EmptyRequest" }, "type": "object" }, "ReportDetailedModel": { "description": "Report detailed model.", "properties": { "orgId": { "description": "Organization Id.", "type": "integer", "format": "int32" }, "createStamp": { "description": "Creation date/time.", "type": "string" }, "createUsername": { "description": "Creator username.", "type": "string" }, "lastChangeStamp": { "description": "Last change stamp.", "type": "string" }, "type": { "description": "Report type.", "type": "string", "enum": [ "AdHocTransferByDay", "AdHocTransferByDayByGroup", "AdHocTransferByDayByUser", "AdHocTransferByGroup", "AdHocTransferByMonth", "AdHocTransferByMonthByGroup", "AdHocTransferByMonthByUser", "AdHocTransferByUser", "AdHocTransferByWeek", "AdHocTransferByWeekByGroup", "AdHocTransferByWeekByUser", "AdHocTransferTotal", "AdHocTransferUserSnapshot", "ContentScanningDLPViolations", "ContentScanningMaintenanceByActivity", "ContentScanningMaintenanceByActivityByDay", "ContentScanningMaintenanceByActivityByMonth", "ContentScanningMaintenanceByActivityByWeek", "ContentScanningMaintenanceByDay", "ContentScanningMaintenanceByMonth", "ContentScanningMaintenanceByWeek", "ContentScanningMaintenanceTotal", "ContentScanningViolations", "FileTransferByDay", "FileTransferByGroup", "FileTransferByGroupByDay", "FileTransferByGroupByMonth", "FileTransferByGroupByWeek", "FileTransferByIP", "FileTransferByIPByDay", "FileTransferByIPByMonth", "FileTransferByIPByWeek", "FileTransferByInterface", "FileTransferByInterfaceByDay", "FileTransferByInterfaceByMonth", "FileTransferByInterfaceByWeek", "FileTransferByMonth", "FileTransferByUser", "FileTransferByUserByDay", "FileTransferByUserByMonth", "FileTransferByUserByWeek", "FileTransferByWeek", "FileTransferTotal", "PerformanceCPUAll", "PerformanceCPUByDay", "PerformanceCPUByHour", "PerformanceDiskAll", "PerformanceDiskByDay", "PerformanceDiskByHour", "PerformanceHandlesAll", "PerformanceHandlesByDay", "PerformanceHandlesByHour", "PerformanceMemUsageAll", "PerformanceMemUsageByDay", "PerformanceMemUsageByHour", "PerformanceProcessesAll", "PerformanceProcessesByDay", "PerformanceProcessesByHour", "PerformanceSessionsAll", "PerformanceSessionsByDay", "PerformanceSessionsByHour", "PerformanceSummaryAll", "PerformanceSummaryByDay", "PerformanceSummaryByHour", "PerformanceThreadsAll", "PerformanceThreadsByDay", "PerformanceThreadsByHour", "PerformanceVMSizeAll", "PerformanceVMSizeByDay", "PerformanceVMSizeByHour", "SecurityLockedOutIPsCurrent", "SecurityLockedOutIPsHistorical", "SecurityLockedOutUsersCurrent", "SecurityLockedOutUsersHistorical", "SecuritySuspiciousIPsManyAttempts", "SecuritySuspiciousIPsManyUsernames", "SecuritySuspiciousUsernamesManyAttempts", "SecuritySuspiciousUsernamesManyIPs", "SecurityWhitelistedIPs", "StorageByAge", "StorageByAgeIncludingSubFolders", "StorageByFolder", "StorageByFolderIncludingSubFolders", "StorageByGroup", "StorageByUser", "StorageTotal", "SystemOrgKeyRotations", "SystemOrgKeys", "UserMaintenanceByActivity", "UserMaintenanceByActivityByDay", "UserMaintenanceByActivityByMonth", "UserMaintenanceByActivityByWeek", "UserMaintenanceByDay", "UserMaintenanceByMonth", "UserMaintenanceByWeek", "UserMaintenanceTotal", "UserStatusActiveUsers", "UserStatusAddressBooks", "UserStatusDefaultHomeFolderPermissions", "UserStatusFolderPermissions", "UserStatusFolderQuotaAny", "UserStatusFolderQuotaDefined", "UserStatusFolderQuotaNearAbove", "UserStatusGroupMembership", "UserStatusGroupSummary", "UserStatusInactiveUsers", "UserStatusPackageQuotaAny", "UserStatusPackageQuotaDefined", "UserStatusPackageQuotaNearAbove", "UserStatusPasswordAboutToExpire", "UserStatusSignOnNoticeAccepted", "UserStatusUserListForAuditors", "CustomCustom", "DefaultDefault", "Unknown" ] }, "outputFormat": { "description": "Report output format.", "type": "string", "enum": [ "XML", "CSV", "HTMLNAKED", "HTMLSTYLED", "Unknown" ] }, "showQuery": { "description": "True if show query.", "type": "boolean" }, "csvDelimiter": { "description": "Delimiter.", "type": "string" }, "csvQuoteMark": { "description": "Quote char.", "type": "string" }, "csvEscapeFormulaPrefix": { "description": "Escape formula prefix.", "type": "integer", "format": "int32" }, "schedule": { "description": "Schedule.", "type": "string" }, "saveInFolder": { "description": "Folder path to save in.", "type": "string" }, "saveAsFile": { "description": "Save as file.", "type": "string" }, "overwriteExistingFile": { "description": "True if overwrite existing file.", "type": "boolean" }, "optionStartDate": { "description": "Report option start date.", "type": "string" }, "optionEndDate": { "description": "Report option end date.", "type": "string" }, "optionSizeUnits": { "description": "Report size unit.", "type": "string", "enum": [ "KB", "MB", "GB", "Unknown" ] }, "optionAttemptThreshold": { "description": "Attempt threshold.", "type": "integer", "format": "int32" }, "optionIPThreshold": { "description": "IP threshold.", "type": "integer", "format": "int32" }, "optionUsernameThreshold": { "description": "Username threshold.", "type": "integer", "format": "int32" }, "customFields": { "description": "Custom fields.", "type": "string" }, "customTables": { "description": "Custom tables.", "type": "string" }, "customCriteria": { "description": "Custom criteria.", "type": "string" }, "customGrouping": { "description": "Custom grouping.", "type": "string" }, "customOrder": { "description": "Custom order.", "type": "string" }, "customLimit": { "description": "Custom limit.", "type": "string" }, "id": { "description": "Report Id.", "type": "integer", "format": "int32" }, "title": { "description": "Report name.", "type": "string" }, "category": { "description": "Report category.", "type": "string", "enum": [ "FileTransfer", "AdHocTransfer", "Storage", "UserMaintenance", "UserStatus", "Security", "Performance", "ContentScanning", "System", "Custom", "Default", "Unknown" ] } }, "xml": { "name": "ReportDetailedModel" }, "type": "object" }, "IPWhitelistListRequest": { "properties": { "page": { "description": "Page number to display", "type": "integer", "format": "int32" }, "perPage": { "description": "Items per page in result collection; Default is 25", "type": "integer", "format": "int32" }, "sortField": { "description": "Name of field to sort the results by. (IPAddress, Id, Comment); Default is IPAddress.", "type": "string" }, "sortDirection": { "description": "Sort direction; Default is ascending.", "type": "string" } }, "xml": { "name": "IPWhitelistListRequest" }, "type": "object" }, "PagedModelOfWhitelistedIPDto": { "description": "Represents paged response object with proper navigations", "properties": { "items": { "description": "Items on the given page", "items": { "$ref": "#/definitions/WhitelistedIPDto" }, "readOnly": true, "xml": { "name": "WhitelistedIPDto", "wrapped": true }, "type": "array" }, "paging": { "$ref": "#/definitions/PagingInfoModel", "description": "Paging data for given response" }, "sorting": { "description": "Sorting data for given response", "items": { "$ref": "#/definitions/SortFieldDto" }, "xml": { "name": "SortFieldDto", "wrapped": true }, "type": "array" } }, "xml": { "name": "PagedModel`1" }, "type": "object" }, "WhitelistedIPDto": { "properties": { "id": { "description": "Rule Id.", "type": "integer", "format": "int32" }, "ipAddress": { "description": "Whitelisted IP Address or IP Address Range.", "type": "string" }, "comment": { "description": "Comment.", "type": "string" } }, "xml": { "name": "WhitelistedIPDto" }, "type": "object" }, "IPWhitelistRequestModel": { "properties": { "ipAddress": { "description": "Whitelisted IP Address or IP Address Range.", "type": "string" }, "comment": { "description": "Comment.", "type": "string" } }, "xml": { "name": "IPWhitelistRequestModel" }, "type": "object" }, "IPWhitelistResponseModel": { "properties": { "id": { "description": "Rule Id.", "type": "integer", "format": "int32" }, "ipAddress": { "description": "Whitelisted IP Address or IP Address Range.", "type": "string" }, "comment": { "description": "Comment.", "type": "string" } }, "xml": { "name": "IPWhitelistResponseModel" }, "type": "object" }, "PasswordAgingPoliciesListRequest": { "properties": { "page": { "description": "Page number to display", "type": "integer", "format": "int32" }, "perPage": { "description": "Items per page in result collection; Default is 25", "type": "integer", "format": "int32" }, "sortField": { "description": "Name of field to sort the results by. (name); Default is Name.", "type": "string" }, "sortDirection": { "description": "Sort direction; Default is ascending.", "type": "string" } }, "xml": { "name": "PasswordAgingPoliciesListRequest" }, "type": "object" }, "PagedModelOfSimplePasswordAgingPolicyModel": { "description": "Represents paged response object with proper navigations", "properties": { "items": { "description": "Items on the given page", "items": { "$ref": "#/definitions/SimplePasswordAgingPolicyModel" }, "readOnly": true, "xml": { "name": "SimplePasswordAgingPolicyModel", "wrapped": true }, "type": "array" }, "paging": { "$ref": "#/definitions/PagingInfoModel", "description": "Paging data for given response" }, "sorting": { "description": "Sorting data for given response", "items": { "$ref": "#/definitions/SortFieldDto" }, "xml": { "name": "SortFieldDto", "wrapped": true }, "type": "array" } }, "xml": { "name": "PagedModel`1" }, "type": "object" }, "SimplePasswordAgingPolicyModel": { "description": "Represents simple password aging policy required for all scenarios", "properties": { "id": { "description": "Password aging policy id.", "type": "integer", "format": "int32" }, "name": { "description": "Password aging policy name.", "type": "string" } }, "xml": { "name": "SimplePasswordAgingPolicyModel" }, "type": "object" }, "PasswordAgingPolicyAddModel": { "description": "Represents data required for create password aging policy", "properties": { "name": { "description": "Password aging policy name.", "type": "string" }, "description": { "description": "Password aging policy description.", "type": "string" }, "passwordAgeTime": { "description": "Password expires every (x) days. Default is -1.", "type": "integer", "format": "int32" }, "passwordAgeWarn": { "description": "Indicate days remaining at sign on and using email beginning (x) day(s) in advance. Default is -1.", "type": "integer", "format": "int32" }, "passwordAgeGrace": { "description": "Enable a grace period (x) day(s) after password expires. Default is -1.\r\nAfter the grace period the user account will be suspended and an administrator must reactivate it.", "type": "integer", "format": "int32" } }, "xml": { "name": "PasswordAgingPolicyAddModel" }, "type": "object" }, "PasswordAgingPolicyModel": { "description": "Represents password aging policy required for all scenarios", "properties": { "description": { "description": "Password aging policy description.", "type": "string" }, "passwordAgeTime": { "description": "Password expires every (x) days.", "type": "integer", "format": "int32" }, "passwordAgeWarn": { "description": "Indicate days remaining at sign on and using email beginning (x) day(s) in advance.", "type": "integer", "format": "int32" }, "passwordAgeGrace": { "description": "Enable a grace period (x) day(s) after password expires.\r\nAfter the grace period the user account will be suspended and an administrator must reactivate it.", "type": "integer", "format": "int32" }, "numUsing": { "description": "Number of password aging policy using.", "type": "integer", "format": "int32" }, "id": { "description": "Password aging policy id.", "type": "integer", "format": "int32" }, "name": { "description": "Password aging policy name.", "type": "string" } }, "xml": { "name": "PasswordAgingPolicyModel" }, "type": "object" }, "ExpirationPoliciesListRequest": { "properties": { "page": { "description": "Page number to display", "type": "integer", "format": "int32" }, "perPage": { "description": "Items per page in result collection; Default is 25", "type": "integer", "format": "int32" }, "sortField": { "description": "Name of field to sort the results by. (name); Default is Name.", "type": "string" }, "sortDirection": { "description": "Sort direction; Default is ascending.", "type": "string" } }, "xml": { "name": "ExpirationPoliciesListRequest" }, "type": "object" }, "PagedModelOfSimpleExpirationPolicyModel": { "description": "Represents paged response object with proper navigations", "properties": { "items": { "description": "Items on the given page", "items": { "$ref": "#/definitions/SimpleExpirationPolicyModel" }, "readOnly": true, "xml": { "name": "SimpleExpirationPolicyModel", "wrapped": true }, "type": "array" }, "paging": { "$ref": "#/definitions/PagingInfoModel", "description": "Paging data for given response" }, "sorting": { "description": "Sorting data for given response", "items": { "$ref": "#/definitions/SortFieldDto" }, "xml": { "name": "SortFieldDto", "wrapped": true }, "type": "array" } }, "xml": { "name": "PagedModel`1" }, "type": "object" }, "SimpleExpirationPolicyModel": { "description": "Represents simple user auth expiration policy required for all scenarios", "properties": { "id": { "description": "Expiration policy id", "type": "integer", "format": "int32" }, "name": { "description": "Expiration policy name", "type": "string" } }, "xml": { "name": "SimpleExpirationPolicyModel" }, "type": "object" }, "ExpirationPolicyAddModel": { "description": "Represents data required for create user auth expiration policy", "properties": { "name": { "description": "Expiration policy name", "type": "string" }, "description": { "description": "Expiration policy description. Default is empty string.", "type": "string" }, "expireDate": { "description": "Expire after date", "type": "string" }, "creationExpireTime": { "description": "Expire X day(s) after creation. Default is -1.", "type": "integer", "format": "int32" }, "activityExpireTime": { "description": "Expire X day(s) after last activity. Default is -1.", "type": "integer", "format": "int32" }, "expireAfterActivityIncludesPkgs": { "description": "Receiving packages counts as \"activity\". Default is false", "type": "boolean" }, "signonExpireNumber": { "description": "Expire after (x) successful signon(s). Default is -1.", "type": "integer", "format": "int32" }, "expireWarnTime": { "description": "Warn (x) day(s) before expiration. Default is -1.", "type": "integer", "format": "int32" }, "expirationNotice": { "description": "Notify user when their account expires (Default is false)", "type": "boolean" } }, "xml": { "name": "ExpirationPolicyAddModel" }, "type": "object" }, "ExpirationPolicyModel": { "description": "Represents user auth expiration policy required for all scenarios", "properties": { "description": { "description": "Expiration policy description", "type": "string" }, "expireDate": { "description": "Expire after date", "type": "string" }, "creationExpireTime": { "description": "Expire X day(s) after creation", "type": "integer", "format": "int32" }, "activityExpireTime": { "description": "Expire X day(s) after last activity", "type": "integer", "format": "int32" }, "expireAfterActivityIncludesPkgs": { "description": "Receiving packages counts as \"activity\"", "type": "boolean" }, "signonExpireNumber": { "description": "Expire after (x) successful signon(s)", "type": "integer", "format": "int32" }, "expireWarnTime": { "description": "Warn (x) day(s) before expiration", "type": "integer", "format": "int32" }, "expirationNotice": { "description": "Notify user when their account expires", "type": "boolean" }, "numUsing": { "description": "Number of expiration policy using", "type": "integer", "format": "int32" }, "id": { "description": "Expiration policy id", "type": "integer", "format": "int32" }, "name": { "description": "Expiration policy name", "type": "string" } }, "xml": { "name": "ExpirationPolicyModel" }, "type": "object" }, "RemoteAccessRuleAddModel": { "description": "Represents data required for create remote access default rule", "required": [ "host", "permitType" ], "properties": { "rule": { "description": "Rule type (Allow/Deny).", "type": "string", "enum": [ "Deny", "Allow" ] }, "host": { "description": "Hostname/IP.", "type": "string" }, "permitType": { "description": "Permit type.", "type": "string", "enum": [ "Admin", "EndUser" ] }, "priority": { "description": "Rule priority level.", "type": "string", "enum": [ "Highest", "Middle", "Lowest" ] }, "comment": { "description": "Rule comment.", "type": "string" } }, "xml": { "name": "RemoteAccessRuleAddModel" }, "type": "object" }, "RemoteAccessRuleModel": { "description": "Represents remote access rule data required for all scenarios", "properties": { "id": { "description": "Rule Id.", "type": "string" }, "orgId": { "description": "Organization Id.", "type": "string" }, "rule": { "description": "Rule type (Allow/Deny).", "type": "string", "enum": [ "Deny", "Allow" ] }, "host": { "description": "Hostname/IP.", "type": "string" }, "permitType": { "description": "Permit type.", "type": "string", "enum": [ "Admin", "EndUser" ] }, "comment": { "description": "Comment.", "type": "string" }, "priority": { "description": "Rule priority.", "type": "string" }, "hostnameLookup": { "description": "Hostname lookup.", "type": "string" } }, "xml": { "name": "RemoteAccessRuleModel" }, "type": "object" }, "PasswordPermissionsUpdateRequest": { "properties": { "passwordChangeEmailNotificationType": { "description": "Email notification type while Admins and GroupAdmins creating or editing users.\r\nDefault is None.", "type": "string", "enum": [ "None", "SendPasswordByEmail", "SendResetLinkByEmail" ] }, "allowToChangeOwnPassword": { "description": "Allow end users to change their own passwords after signing on(e.g., from \"My Account\").\r\nDefault is false.", "type": "boolean" }, "allowPasswordChangeRequests": { "description": "Allow end users to reset their own passwords without signing on (Email \"Reset Password\" links to users who request them from the signon page).\r\nDefault is false.", "type": "boolean" }, "isRecaptchaRequired": { "description": "Require users to respond to reCAPTCHA when resetting their password without signing on.\r\nTo enable this option reCAPTCHA should be configured.\r\nDefault is false.", "type": "boolean" }, "isSecurityQuestionsRequired": { "description": "Require users to answer security questions when resetting their password without signing on.\r\nNOTE: Users will be required to select and answer security questions at next sign-on.\r\nDefault is false.", "type": "boolean" }, "passwordEmailLinkMaxAge": { "description": "Email links used in \"Set Password\" and \"Reset Password\" processes will expire after X minutes.", "type": "integer", "format": "int32" } }, "xml": { "name": "PasswordPermissionsUpdateRequest" }, "type": "object" }, "PasswordPermissionsModel": { "description": "Represents password permissions settings.", "properties": { "passwordChangeEmailNotificationType": { "description": "Email notification type while Admins and GroupAdmins creating or editing users.\r\nDefault is None.", "type": "string", "enum": [ "None", "SendPasswordByEmail", "SendResetLinkByEmail" ] }, "allowToChangeOwnPassword": { "description": "Allow end users to change their own passwords after signing on(e.g., from \"My Account\").\r\nDefault is false.", "type": "boolean" }, "allowPasswordChangeRequests": { "description": "Allow end users to reset their own passwords without signing on (Email \"Reset Password\" links to users who request them from the signon page).\r\nDefault is false.", "type": "boolean" }, "isRecaptchaRequired": { "description": "Require users to respond to reCAPTCHA when resetting their password without signing on.\r\nTo enable this option reCAPTCHA should be configured.\r\nDefault is false.", "type": "boolean" }, "isSecurityQuestionsRequired": { "description": "Require users to answer security questions when resetting their password without signing on.\r\nNOTE: Users will be required to select and answer security questions at next sign-on.\r\nDefault is false.", "type": "boolean" }, "passwordEmailLinkMaxAge": { "description": "Email links used in \"Set Password\" and \"Reset Password\" processes will expire after X minutes.", "type": "integer", "format": "int32" } }, "xml": { "name": "PasswordPermissionsModel" }, "type": "object" }, "UserClassPasswordAgingPolicyPatchModel": { "description": "Represents data required for update account user password aging policy", "properties": { "userPermission": { "description": "User permission type.", "type": "string", "enum": [ "Anonymous", "TemporaryUser", "User", "AuditUser", "FileAdmin", "Admin" ] }, "policyId": { "description": "User password aging policy id. Use \"0\" to set \"None\" value.", "type": "integer", "format": "int32" }, "applyToExistingUsers": { "description": "Apply password aging policy to existing users. Default is true.", "type": "boolean" } }, "xml": { "name": "UserClassPasswordAgingPolicyPatchModel" }, "type": "object" }, "UserClassPasswordAgingPolicyModel": { "description": "Represents account user password aging policy required for all scenarios", "properties": { "adminPasswordAgingPolicyId": { "description": "Admin password aging policy id.", "type": "integer", "format": "int32" }, "fileAdminPasswordAgingPolicyId": { "description": "File admin password aging policy id.", "type": "integer", "format": "int32" }, "userPasswordAgingPolicyId": { "description": "End user password aging policy id.", "type": "integer", "format": "int32" }, "tempUserPasswordAgingPolicyId": { "description": "Temporary user password aging policy id.", "type": "integer", "format": "int32" } }, "xml": { "name": "UserClassPasswordAgingPolicyModel" }, "type": "object" }, "UserClassExpirationPolicyPatchModel": { "description": "Represents data required for update account user auth expiration policy", "properties": { "userPermission": { "description": "User permission type.", "type": "string", "enum": [ "Anonymous", "TemporaryUser", "User", "AuditUser", "FileAdmin", "Admin" ] }, "policyId": { "description": "User expiration policy id. Use \"0\" to set \"None\" value.", "type": "integer", "format": "int32" }, "applyToExistingUsers": { "description": "Apply expiration policy to existing users. Default is true.", "type": "boolean" } }, "xml": { "name": "UserClassExpirationPolicyPatchModel" }, "type": "object" }, "UserClassExpirationPolicyModel": { "description": "Represents account user auth expiration policy required for all scenarios", "properties": { "adminExpirationPolicyId": { "description": "Admin expiration policy id.", "type": "integer", "format": "int32" }, "fileAdminExpirationPolicyId": { "description": "File admin expiration policy id.", "type": "integer", "format": "int32" }, "userExpirationPolicyId": { "description": "End user expiration policy id.", "type": "integer", "format": "int32" }, "tempUserExpirationPolicyId": { "description": "Temporary user expiration policy id.", "type": "integer", "format": "int32" }, "auditUserExpirationPolicyId": { "description": "Audit user expiration policy id.", "type": "integer", "format": "int32" } }, "xml": { "name": "UserClassExpirationPolicyModel" }, "type": "object" }, "GetTransferStatusListRequest": { "description": "Represents required information in order to create a request to retrieve list of XferStatus.\r\nIf several filtering criteria are provided they are matched using AND logic, e.g. File Name is \"abc\" and userFullName is \"John\"", "properties": { "recentlyCompletedPeriod": { "description": "Time period in seconds to return recently completed data. Default: 0", "type": "integer", "format": "int32" }, "statusDistributionPeriod": { "description": "Time period in seconds to calculate status distribution for. Default: RecentlyCompletedPeriod", "type": "integer", "format": "int32" }, "userLoginName": { "description": "Filter expression for Login name", "type": "string" }, "userFullName": { "description": "Filter expression for User Display name", "type": "string" }, "userIp": { "description": "Filter expression for User IP", "type": "string" }, "folderName": { "description": "Filter expression for Folder name", "type": "string" }, "fileName": { "description": "Filter expression for File name", "type": "string" }, "transferStatus": { "description": "Filter for status. Uses OR logic", "items": { "type": "string", "enum": [ "Failed", "Stalled", "Active", "Completed" ] }, "xml": { "name": "TransferStatusEnum", "wrapped": true }, "type": "array" }, "search": { "description": "Filter expression for several fields. Fields are matched with OR logic. AND logic is used if you provide expression for each particular query. Fields being matched: userLoginName, userFullName, userIp, folderName, fileName", "type": "string" }, "page": { "description": "Page number to display", "type": "integer", "format": "int32" }, "perPage": { "description": "Items per page in result collection", "type": "integer", "format": "int32" }, "sortField": { "description": "Name of field to sort the results by.", "type": "string" }, "sortDirection": { "description": "Sort direction; Default is ascending.", "type": "string" }, "useDisplayTimeZone": { "description": "Whether to convert timestamps returned by the endpoint from the server's\r\ntime zone to the user's configured display time zone.", "type": "boolean" } }, "xml": { "name": "GetTransferStatusListRequest" }, "type": "object" }, "TransferStatusPagedModel": { "properties": { "statusDistribution": { "$ref": "#/definitions/TransferStatusDistribution", "description": "Status distribution" }, "items": { "description": "Items on the given page", "items": { "$ref": "#/definitions/TransferStatusModel" }, "readOnly": true, "xml": { "name": "TransferStatusModel", "wrapped": true }, "type": "array" }, "paging": { "$ref": "#/definitions/PagingInfoModel", "description": "Paging data for given response" }, "sorting": { "description": "Sorting data for given response", "items": { "$ref": "#/definitions/SortFieldDto" }, "xml": { "name": "SortFieldDto", "wrapped": true }, "type": "array" } }, "xml": { "name": "TransferStatusPagedModel" }, "type": "object" }, "TransferStatusDistribution": { "description": "Distribution of available statuses in collection", "properties": { "active": { "description": "Number of records in Active state", "type": "integer", "format": "int32" }, "stalled": { "description": "Number of records in Stalled state", "type": "integer", "format": "int32" }, "completed": { "description": "Number of records in Succeeded state", "type": "integer", "format": "int32" }, "failed": { "description": "Number of records in Failed state", "type": "integer", "format": "int32" }, "lingeringTransfers": { "description": "Number of transfers that have recently been completed but still are displayed as in progress", "type": "integer", "format": "int32" } }, "xml": { "name": "TransferStatusDistribution" }, "type": "object" }, "TransferStatusModel": { "description": "Represents active transfer information", "properties": { "nodeNum": { "description": "Web Farm node number", "type": "integer", "format": "int32" }, "moduleName": { "description": "Module which performs transfer", "type": "string", "enum": [ "Other", "FTP", "SSH", "ISAPI", "REST" ] }, "direction": { "description": "Transfer direction", "type": "string", "enum": [ "Upload", "Download" ] }, "transferStatus": { "description": "Transfer status", "type": "string", "enum": [ "Failed", "Stalled", "Active", "Completed" ] }, "statusMessage": { "description": "Information about the transfer status, such as an error message", "type": "string" }, "errorCode": { "description": "Information about the transfer status, such as an error code", "type": "integer", "format": "int32" }, "orgId": { "description": "ID of organization this file belongs to", "type": "integer", "format": "int32" }, "userId": { "description": "ID of the user", "type": "string" }, "userLoginName": { "description": "User Login Name", "type": "string" }, "userFullName": { "description": "User Real Name", "type": "string" }, "userIp": { "description": "IP Address of user", "type": "string" }, "timeStarted": { "description": "Time when transfer started", "type": "string" }, "timeEnded": { "description": "Time when transfer ended. Null if transfer is in progress", "type": "string" }, "currentBytes": { "description": "Bytes already transferred", "type": "integer", "format": "int64" }, "totalBytes": { "description": "Total file size, if known", "type": "integer", "format": "int64" }, "transferRate": { "description": "Rate of the transfer", "type": "integer", "format": "int64" }, "fileId": { "description": "ID of the file", "type": "string" }, "fileName": { "description": "File Name", "type": "string" }, "folderId": { "description": "Parent Folder ID", "type": "string" }, "folderName": { "description": "Parent Folder Name", "type": "string" }, "folderPath": { "description": "Parent Folder Path", "type": "string" }, "folderType": { "description": "Parent Folder Type", "type": "string", "enum": [ "Virtual", "Normal", "Archive", "Webpost", "GlobalMessaging", "Mailbox", "Root", "RootArchives", "RootWebposts" ] }, "agentVersion": { "description": "User agent version", "type": "string" }, "agentBrand": { "description": "User agent brand", "type": "string" }, "integrityVerified": { "description": "Integrity Verified", "type": "boolean" } }, "xml": { "name": "TransferStatusModel" }, "type": "object" }, "UserDetailsModel": { "description": "Detailed user model.", "properties": { "emailFormat": { "description": "Format of email notifications user receives.", "type": "string", "enum": [ "HTML", "Text" ] }, "notes": { "description": "User description.", "type": "string" }, "statusNote": { "description": "User security status description.", "type": "string" }, "passwordChangeStamp": { "description": "Time of last user password change. Null if user hasn't changed password yet", "type": "string" }, "receivesNotification": { "description": "User email notifications setting.", "type": "string", "enum": [ "ReceivesNoNotifications", "ReceivesNotifications", "AdminReceivesNotifications" ] }, "forceChangePassword": { "description": "If set to 1, user must change their password on their next login.", "type": "boolean" }, "folderQuota": { "description": "User quota value, or 0 for no quota.", "type": "integer", "format": "int64" }, "totalFileSize": { "description": "Total size of all files", "type": "integer", "format": "int64" }, "authMethod": { "description": "User authentication method; only takes effect if the organization\r\nis set to \"External then MOVEit\" authentication.", "type": "string", "enum": [ "MOVEitOnly", "ExternalOnly", "Both" ] }, "language": { "description": "User language code.", "type": "string" }, "homeFolderID": { "description": "ID of user home folder, or 0 for no home folder.", "type": "integer", "format": "int64" }, "defaultFolderID": { "description": "ID of user default folder; 0 indicates the home folder is the default folder.", "type": "integer", "format": "int64" }, "expirationPolicyID": { "description": "ID of the expiration policy configured for this user, or 0 for no policy.", "type": "integer", "format": "int32" }, "displaySettings": { "$ref": "#/definitions/DisplaySettingsModel" }, "id": { "description": "User ID.", "type": "string" }, "orgID": { "description": "ID of organization user is a member of.", "type": "integer", "format": "int32" }, "username": { "description": "User login name.", "type": "string" }, "fullName": { "description": "User full name.", "type": "string" }, "permission": { "description": "User permission.", "type": "string", "enum": [ "Anonymous", "TemporaryUser", "User", "AuditUser", "FileAdmin", "Admin", "SysAdmin" ] }, "email": { "description": "User email address.", "type": "string" }, "status": { "description": "User security status.", "type": "string", "enum": [ "Active", "Suspended", "Template" ] }, "lastLoginStamp": { "description": "Time of last user login. Null if user has not logged in yet.", "type": "string" } }, "xml": { "name": "UserDetailsModel" }, "type": "object" }, "DisplaySettingsModel": { "description": "Information about configured display setting", "properties": { "userListPageSize": { "description": "User/group entries per page", "type": "integer", "format": "int32" }, "fileListPageSize": { "description": "Files/folders entries per page", "type": "integer", "format": "int32" }, "liveViewPageSize": { "description": "Live transfer entries per page", "type": "integer", "format": "int32" } }, "xml": { "name": "DisplaySettingsModel" }, "type": "object" }, "UserRequest": { "properties": { "id": { "description": "User ID", "type": "string" } }, "xml": { "name": "UserRequest" }, "type": "object" }, "UserPatchModel": { "description": "Contains the user properties that should change", "properties": { "authMethod": { "description": "Auth method type", "type": "string", "enum": [ "MOVEitOnly", "ExternalOnly", "Both" ] }, "defaultFolderId": { "description": "Default folder ID", "type": "integer", "format": "int64" }, "email": { "description": "Email address", "type": "string" }, "emailFormat": { "description": "Email format type", "type": "string", "enum": [ "HTML", "Text" ] }, "forceChangePassword": { "description": "Force password change", "type": "boolean" }, "language": { "description": "Language", "type": "string" }, "notes": { "description": "Notes", "type": "string" }, "receivesNotification": { "description": "Notification type", "type": "string", "enum": [ "ReceivesNoNotifications", "ReceivesNotifications", "AdminReceivesNotifications" ] }, "currentPassword": { "description": "Current user password; required if the current user is updating their own password", "type": "string" }, "password": { "description": "User password", "type": "string" }, "sendPasswordChangeNotification": { "description": "When set to True, sends a notification to the user either informing them about\r\na newly set password, or providing a link for them to reset their own password,\r\ndepending on the configuration of the organization.", "type": "boolean" }, "permission": { "description": "User permission type", "type": "string", "enum": [ "Anonymous", "TemporaryUser", "User", "AuditUser", "FileAdmin", "Admin", "SysAdmin" ] }, "folderQuota": { "description": "User quota", "type": "integer", "format": "int64" }, "fullName": { "description": "Real name of user", "type": "string" }, "status": { "description": "User status type", "type": "string", "enum": [ "Active", "Suspended", "Template" ] }, "statusNote": { "description": "User status note", "type": "string" } }, "xml": { "name": "UserPatchModel" }, "type": "object" }, "UserGroupsRequest": { "description": "User list query.", "properties": { "page": { "description": "Page number to display", "type": "integer", "format": "int32" }, "perPage": { "description": "Items per page in result collection; Default is 25", "type": "integer", "format": "int32" }, "id": { "description": "User ID.", "type": "string" } }, "xml": { "name": "UserGroupsRequest" }, "type": "object" }, "PagedModelOfUserGroupModel": { "description": "Represents paged response object with proper navigations", "properties": { "items": { "description": "Items on the given page", "items": { "$ref": "#/definitions/UserGroupModel" }, "readOnly": true, "xml": { "name": "UserGroupModel", "wrapped": true }, "type": "array" }, "paging": { "$ref": "#/definitions/PagingInfoModel", "description": "Paging data for given response" }, "sorting": { "description": "Sorting data for given response", "items": { "$ref": "#/definitions/SortFieldDto" }, "xml": { "name": "SortFieldDto", "wrapped": true }, "type": "array" } }, "xml": { "name": "PagedModel`1" }, "type": "object" }, "UserGroupModel": { "description": "Represents a group that a specific user is a member of, including the relationship that user has with the group.", "properties": { "relationship": { "description": "User Group relationship", "type": "string", "enum": [ "Member", "GroupAdmin" ] }, "name": { "description": "Name of the group.", "type": "string" }, "description": { "description": "Additional information, related to the group.", "type": "string" } }, "xml": { "name": "UserGroupModel" }, "type": "object" }, "CurrentUserExternalTokensRequest": { "description": "Represents requred information in order to create a request to retreive list of external tokens of the current user.", "properties": { "page": { "description": "Page number to display", "type": "integer", "format": "int32" }, "perPage": { "description": "Items per page in result collection; Default is 25", "type": "integer", "format": "int32" }, "sortField": { "description": "Name of field to sort the results by. (TokenId, LastUsed, RegisteredAt or TokenType); Default is DisplayName.", "type": "string" }, "sortDirection": { "description": "Sort direction; Default is ascending.", "type": "string" } }, "xml": { "name": "CurrentUserExternalTokensRequest" }, "type": "object" }, "PagedModelOfUserExternalTokenModel": { "description": "Represents paged response object with proper navigations", "properties": { "items": { "description": "Items on the given page", "items": { "$ref": "#/definitions/UserExternalTokenModel" }, "readOnly": true, "xml": { "name": "UserExternalTokenModel", "wrapped": true }, "type": "array" }, "paging": { "$ref": "#/definitions/PagingInfoModel", "description": "Paging data for given response" }, "sorting": { "description": "Sorting data for given response", "items": { "$ref": "#/definitions/SortFieldDto" }, "xml": { "name": "SortFieldDto", "wrapped": true }, "type": "array" } }, "xml": { "name": "PagedModel`1" }, "type": "object" }, "UserExternalTokenModel": { "properties": { "id": { "description": "ID of the token in the database.", "type": "string" }, "tokenID": { "description": "ID of the external token.", "type": "string" }, "instID": { "description": "ID of the organization this external token exists in.", "type": "integer", "format": "int32" }, "displayName": { "description": "Display Name of the external token. \r\nDefaults to user's email address.", "type": "string" }, "registeredAt": { "description": "Time of token registration.", "type": "string" }, "lastUsed": { "description": "Time of last token use.", "type": "string" }, "tokenType": { "description": "External Token Type.", "type": "string", "enum": [ "MicrosoftOutlook" ] } }, "xml": { "name": "UserExternalTokenModel" }, "type": "object" }, "RegisterExternalTokenRequest": { "description": "Request to register an external token with the current user account.", "properties": { "check": { "description": "When true, check if token will be accepted, but do not register it", "type": "boolean" }, "type": { "description": "Type of token", "type": "string", "enum": [ "MicrosoftOutlook" ] }, "token": { "description": "Token content", "type": "string" } }, "xml": { "name": "RegisterExternalTokenRequest" }, "type": "object" }, "CurrentUserDeleteExternalTokenByTokenRequest": { "description": "Request to delete an external token using the encoded token string.", "properties": { "type": { "description": "Type of token", "type": "string", "enum": [ "MicrosoftOutlook" ] }, "token": { "description": "Token content", "type": "string" } }, "xml": { "name": "CurrentUserDeleteExternalTokenByTokenRequest" }, "type": "object" }, "UserExternalTokensRequest": { "description": "Represents requred information in order to create a request to retreive list of external tokens of the user.", "properties": { "id": { "description": "User ID.", "type": "string" }, "page": { "description": "Page number to display", "type": "integer", "format": "int32" }, "perPage": { "description": "Items per page in result collection; Default is 25", "type": "integer", "format": "int32" }, "sortField": { "description": "Name of field to sort the results by. (TokenId, LastUsed, RegisteredAt or TokenType); Default is DisplayName.", "type": "string" }, "sortDirection": { "description": "Sort direction; Default is ascending.", "type": "string" } }, "xml": { "name": "UserExternalTokensRequest" }, "type": "object" }, "UserListRequest": { "description": "User list query.", "properties": { "page": { "description": "Page number to display.", "type": "integer", "format": "int32" }, "perPage": { "description": "Items per page in result collection; Default is 25.", "type": "integer", "format": "int32" }, "sortField": { "description": "Name of field to sort the results by. (username, fullname, lastLoginStamp or email); Default is username.", "type": "string" }, "sortDirection": { "description": "Sort direction; Default is ascending.", "type": "string" }, "permission": { "description": "User permission filter.", "type": "string", "enum": [ "AllUsers", "EndUsers", "Administrators", "FileAdmins", "GroupAdmins", "TemporaryUsers", "SysAdmins", "AuditUsers" ] }, "status": { "description": "User status filter.", "type": "string", "enum": [ "AllUsers", "ActiveUsers", "InactiveUsers", "NeverSignedOnUsers", "TemplateUsers" ] }, "username": { "description": "User login name.", "type": "string" }, "fullName": { "description": "User full name.", "type": "string" }, "email": { "description": "User email.", "type": "string" }, "isExactMatch": { "description": "If true, it will search for exact match of username, fullname and email.", "type": "boolean" }, "orgId": { "description": "Organization ID. (For sysadmin users only. For non sysadmin users current user organization ID is used.)", "type": "integer", "format": "int32" } }, "xml": { "name": "UserListRequest" }, "type": "object" }, "AddUserModel": { "properties": { "sourceUserId": { "description": "Source user ID to clone from.", "type": "string" }, "fullName": { "description": "User full name.", "type": "string" }, "username": { "description": "User login name.", "type": "string" }, "password": { "description": "User password.", "type": "string" }, "email": { "description": "User email address.", "type": "string" }, "permission": { "description": "User permission.", "type": "string", "enum": [ "Anonymous", "TemporaryUser", "User", "AuditUser", "FileAdmin", "Admin", "SysAdmin" ] }, "forceChangePassword": { "description": "If set to true, user must change his password on his next login.", "type": "boolean" }, "orgID": { "description": "ID of organization new user has to be member of.\r\nWill be used only when client user is SysAdmin.\r\nOtherwise it will be ignored and current user organization ID will be used.", "type": "integer", "format": "int32" }, "notes": { "description": "User description.", "type": "string" }, "homeFolderPath": { "description": "Path of user home folder to create.\r\nIf empty no home folder will be created.", "type": "string" }, "homeFolderInUseOption": { "description": "Describes a behavior when\r\nspecified home folder is already in use", "type": "string", "enum": [ "AllowIfExists", "DenyIfExists" ] } }, "xml": { "name": "AddUserModel" }, "type": "object" }, "CurrentUserDeleteExternalTokenRequest": { "description": "Request to delete an external token using its database ID.", "properties": { "id": { "description": "Token ID.", "type": "string" } }, "xml": { "name": "CurrentUserDeleteExternalTokenRequest" }, "type": "object" }, "DeleteExternalTokenRequest": { "properties": { "userId": { "description": "User ID.", "type": "string" }, "id": { "description": "Token ID.", "type": "string" } }, "xml": { "name": "DeleteExternalTokenRequest" }, "type": "object" }, "TokenAcquiredModel": { "description": "Represents successful token request response", "properties": { "access_token": { "description": "API Token", "type": "string" }, "token_type": { "description": "Type of the token", "type": "string" }, "expires_in": { "description": "Number of seconds till token expiration", "type": "integer", "format": "int32" }, "refresh_token": { "description": "Refresh token", "type": "string" }, "mfa_trust_device_token": { "description": "(Optional) Multi-factor authentication trust device token. Could be returned in case of using \"otp\" grant_type and \"mfa_remember_this_device\" set to true.", "type": "string" }, "mfa_trust_device_token_expire_date": { "description": "(Optional) Multi-factor authentication trust device token expire date. Could be returned in case of using \"otp\" grant_type and \"mfa_remember_this_device\" set to true.", "type": "string" } }, "xml": { "name": "TokenAcquiredModel" }, "type": "object" }, "RequestTokenError": { "description": "Authentication failed error", "properties": { "error": { "description": "Error title", "type": "string" }, "error_code": { "description": "Error code", "type": "integer", "format": "int32" }, "error_description": { "description": "Error details", "type": "string" } }, "xml": { "name": "RequestTokenError" }, "type": "object" }, "RequestTokenPasswordChangeRequiredError": { "description": "Authentication error object resulting from a password change being required.", "properties": { "mfa_access_token": { "description": "MFA access token", "type": "string" }, "password_requirements": { "$ref": "#/definitions/PasswordRequirementsHeaderDto", "description": "Password requirements in effect for the current organization." }, "user": { "$ref": "#/definitions/SignonUserInfoHeaderDto", "description": "Information about the user signing on." }, "error": { "readOnly": true, "type": "string", "default": "password_change_required" }, "error_code": { "readOnly": true, "type": "integer", "format": "int32", "default": 3988 }, "error_description": { "description": "Error details", "type": "string" } }, "xml": { "name": "RequestTokenPasswordChangeRequiredError" }, "type": "object" }, "PasswordRequirementsHeaderDto": { "description": "Object containing password requirements", "properties": { "minimum_length": { "description": "Minimum number of characters in passwords", "type": "integer", "format": "int32" }, "username_match_requirement": { "description": "Username matching limitation requirement", "type": "string", "enum": [ "None", "MustNotMatch", "MustNotContain", "MustNotResemble" ] }, "require_letters_numbers": { "description": "Whether both letters and numbers are required in passwords", "type": "boolean" }, "no_dictionary_words": { "description": "Whether dictionary words are prohibited from passwords", "type": "boolean" }, "require_mixed_case": { "description": "Whether both upper- and lower-case letters are required in passwords", "type": "boolean" }, "require_non_alphanumeric": { "description": "Whether non-alphanumeric characters are required in passwords", "type": "boolean" } }, "xml": { "name": "PasswordRequirementsHeaderDto" }, "type": "object" }, "SignonUserInfoHeaderDto": { "properties": { "org_id": { "type": "integer", "format": "int32" } }, "xml": { "name": "SignonUserInfoHeaderDto" }, "type": "object" }, "RequestTokenSecurityNoticeAcceptanceRequiredError": { "description": "Authentication error object resulting from a security notice acceptance being required.", "properties": { "mfa_access_token": { "description": "MFA access token", "type": "string" }, "user": { "$ref": "#/definitions/SignonUserInfoHeaderDto", "description": "Information about the user signing on." }, "error": { "readOnly": true, "type": "string", "default": "accept_security_notice_required" }, "error_code": { "readOnly": true, "type": "integer", "format": "int32", "default": 3985 }, "error_description": { "description": "Error details", "type": "string" } }, "xml": { "name": "RequestTokenSecurityNoticeAcceptanceRequiredError" }, "type": "object" }, "RequestTokenMfaError": { "description": "Authentication failed error", "properties": { "mfa_access_token": { "description": "MFA access token", "type": "string" }, "mfa_supported_methods": { "$ref": "#/definitions/MfaSupportedMethodsHeaderDto", "description": "MFA supported types" }, "error": { "readOnly": true, "type": "string", "default": "mfa_required" }, "error_code": { "readOnly": true, "type": "integer", "format": "int32", "default": 2028 }, "error_description": { "description": "Error details", "type": "string" } }, "xml": { "name": "RequestTokenMfaError" }, "type": "object" }, "MfaSupportedMethodsHeaderDto": { "properties": { "is_mfa_authenticator_enabled": { "type": "boolean" }, "is_mfa_email_enabled": { "type": "boolean" } }, "xml": { "name": "MfaSupportedMethodsHeaderDto" }, "type": "object" }, "RevokeTokenResponse": { "description": "Response for Revoke token operation", "properties": { "message": { "description": "Message", "type": "string" } }, "xml": { "name": "RevokeTokenResponse" }, "type": "object" }, "SendOtpResponseModel": { "description": "Response for send one-time password operation", "properties": { "user": { "$ref": "#/definitions/SendOtpUserModel", "description": "User to whom the email was sent." } }, "xml": { "name": "SendOtpResponseModel" }, "type": "object" }, "SendOtpUserModel": { "description": "User model to whom the email was sent", "properties": { "masked_email": { "description": "Masked email of the user.", "type": "string" } }, "xml": { "name": "SendOtpUserModel" }, "type": "object" } }, "securityDefinitions": { "Authorization": { "type": "apiKey", "description": "Transfer API token. Put token value obtained using following format: \"Bearer {token}\"", "name": "Authorization", "in": "header" } }, "tags": [ { "name": "Authentication" }, { "name": "Files" }, { "name": "Folders" }, { "name": "FolderContent" }, { "name": "Users" }, { "name": "Groups" }, { "name": "Packages" }, { "name": "Mailboxes" }, { "name": "Contacts" }, { "name": "Logs" }, { "name": "SecuritySettings" }, { "name": "MiscellaneousSettings" }, { "name": "AdHocTransferSettings" }, { "name": "Reports" }, { "name": "Organizations" }, { "name": "ServerInfo" }, { "name": "TransferStatus" } ] }