/auth/callback"
}
}
}
}
}
},
"422": {
"description": "Unprocessable Content
Possible error codes: ERR_INPUT_REQUIRED",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
},
"examples": {
"ERR_INPUT_REQUIRED": {
"summary": "Field is required",
"description": "Field is required",
"value": {
"errors": {
"code": "ERR_INPUT_REQUIRED",
"message": "Field is required"
}
}
}
}
}
}
},
"490": {
"description": "Request blocked by WAF"
}
},
"deprecated": false,
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UserTfaTotpVerifySecret.Post"
}
}
}
}
}
},
"/rest/users/me/tfaSetup": {
"put": {
"tags": [
"users"
],
"summary": "Setup 2FA settings",
"description": "Sets the mobile number for the current user's two-factor authentication setup. Only valid when the user's login state is TFA setup. Returns a redirect URL pointing to the next step in the authentication flow.",
"responses": {
"200": {
"description": "2FA settings updated successfully. Returns a redirect URL for the next step in the authentication flow.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AuthRedirectResponse"
},
"examples": {
"TfaSetup": {
"summary": "Redirect URL after 2FA setup",
"value": {
"redirectUrl": "/rest/auth/login"
}
}
}
}
}
},
"403": {
"description": "Forbidden
Possible error codes: ERR_ACCESS_USER",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
},
"examples": {
"ERR_ACCESS_USER": {
"summary": "Insufficient access permissions",
"description": "Insufficient access permissions",
"value": {
"errors": {
"code": "ERR_ACCESS_USER",
"message": "Insufficient access permissions"
}
}
}
}
}
}
},
"490": {
"description": "Request blocked by WAF"
}
},
"deprecated": false,
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UserTfa.Put"
}
}
}
}
}
},
"/rest/users/me/tos": {
"get": {
"tags": [
"users"
],
"summary": "Terms of Service",
"description": "Returns the Terms of Service configuration for the currently authenticated user's profile, including the TOS content, acceptance text, and whether acceptance is required.",
"responses": {
"200": {
"description": "Terms of Service retrieved successfully. Returns the TOS type, content, acceptance text, occurrence, and whether acceptance is required.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TosResponse"
},
"examples": {
"TosData": {
"summary": "TOS requiring acceptance on every login",
"value": {
"type": "html",
"data": "By using this service you agree to our terms.
",
"acceptanceText": "I agree to the Terms of Service",
"occurance": "always",
"isRequired": true
}
}
}
}
}
},
"490": {
"description": "Request blocked by WAF"
}
},
"deprecated": false
},
"post": {
"tags": [
"users"
],
"summary": "Terms of Service",
"description": "Records the current user's acceptance or rejection of the Terms of Service. In the standard login flow, advances the session to the next authentication step and returns a redirect URL. In OTP login mode, returns an empty 200 response.",
"responses": {
"200": {
"description": "Terms of Service acceptance recorded successfully. Returns a redirectUrl string for the next step in the authentication flow. In OTP login mode, returns an empty response.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AuthRedirectResponse"
},
"examples": {
"TosAccepted": {
"summary": "TOS accepted \u2014 proceed to next login step",
"value": {
"redirectUrl": "https:///auth/callback"
}
}
}
}
}
},
"422": {
"description": "Unprocessable Content
Possible error codes: ERR_INPUT_REQUIRED",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
},
"examples": {
"ERR_INPUT_REQUIRED": {
"summary": "Field is required",
"description": "Field is required",
"value": {
"errors": {
"code": "ERR_INPUT_REQUIRED",
"message": "Field is required"
}
}
}
}
}
}
},
"490": {
"description": "Request blocked by WAF"
}
},
"deprecated": false,
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UserTos.Post"
}
}
}
}
}
},
"/rest/users/preauth": {
"post": {
"tags": [
"users"
],
"summary": "User login preauth",
"description": "User login preauth.",
"responses": {
"200": {
"description": "Pre-authentication check completed successfully. Returns the next step in the login flow, either a redirect URL or a signal to show a password field.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PreauthResponse"
},
"examples": {
"ShowPasswordField": {
"summary": "User exists \u2014 show password field",
"value": {
"username": "jane.doe@example.com",
"redirectUrl": null,
"type": "password",
"otp": false
}
},
"SsoRedirect": {
"summary": "SSO domain \u2014 redirect to identity provider",
"value": {
"username": "jane.doe@corp.com",
"redirectUrl": "https:///sso/login?idp=corp",
"type": "redirect",
"otp": false
}
},
"OtpRequired": {
"summary": "OTP package link \u2014 password field with OTP flag",
"value": {
"username": "jane.doe@example.com",
"redirectUrl": null,
"type": "password",
"otp": true
}
}
}
}
}
},
"403": {
"description": "Forbidden
Possible error codes: ERR_ACCESS_USER",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
},
"examples": {
"ERR_ACCESS_USER": {
"summary": "Insufficient access permissions",
"description": "Insufficient access permissions",
"value": {
"errors": {
"code": "ERR_ACCESS_USER",
"message": "Insufficient access permissions"
}
}
}
}
}
}
},
"422": {
"description": "Unprocessable Content
Possible error codes: ERR_INPUT_REQUIRED",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
},
"examples": {
"ERR_INPUT_REQUIRED": {
"summary": "Field is required",
"description": "Field is required",
"value": {
"errors": {
"code": "ERR_INPUT_REQUIRED",
"message": "Field is required"
}
}
}
}
}
}
},
"490": {
"description": "Request blocked by WAF"
}
},
"deprecated": false,
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UserPreauth.Post"
}
}
}
}
}
},
"/rest/users/register": {
"post": {
"tags": [
"users"
],
"summary": "Register a User",
"description": "Registers a new User in the system by specifying an email address and password.",
"responses": {
"204": {
"description": "Registration initiated successfully. A notification email has been sent to the user depending on their account state."
},
"403": {
"description": "Forbidden
Possible error codes: ERR_ACCESS_USER",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
},
"examples": {
"ERR_ACCESS_USER": {
"summary": "Insufficient access permissions",
"description": "Insufficient access permissions",
"value": {
"errors": {
"code": "ERR_ACCESS_USER",
"message": "Insufficient access permissions"
}
}
}
}
}
}
},
"422": {
"description": "Unprocessable Content
Possible error codes: ERR_INPUT_INVALID_EMAIL, ERR_INPUT_REQUIRED, ERR_INPUT_PASSWORD_COMPLEXITY_ERROR",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
},
"examples": {
"ERR_INPUT_INVALID_EMAIL": {
"summary": "Input is not a valid email",
"description": "Input is not a valid email",
"value": {
"errors": {
"code": "ERR_INPUT_INVALID_EMAIL",
"message": "Input is not a valid email"
}
}
},
"ERR_INPUT_REQUIRED": {
"summary": "Field is required",
"description": "Field is required",
"value": {
"errors": {
"code": "ERR_INPUT_REQUIRED",
"message": "Field is required"
}
}
},
"ERR_INPUT_PASSWORD_COMPLEXITY_ERROR": {
"summary": "Password does not meet complexity requirements",
"description": "Password does not meet complexity requirements",
"value": {
"errors": {
"code": "ERR_INPUT_PASSWORD_COMPLEXITY_ERROR",
"message": "Password does not meet complexity requirements"
}
}
}
}
}
}
},
"490": {
"description": "Request blocked by WAF"
}
},
"deprecated": false,
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UserRegister.Post"
}
}
}
}
}
},
"/rest/users/requestPasswordReset": {
"post": {
"tags": [
"users"
],
"summary": "Request for password reset",
"description": "Request for password reset of existing user",
"responses": {
"204": {
"description": "Password reset request processed. A notification email may have been sent depending on the account state. Always returns 204 regardless of whether the email address exists."
},
"403": {
"description": "Forbidden
Possible error codes: ERR_ACCESS_USER",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
},
"examples": {
"ERR_ACCESS_USER": {
"summary": "Insufficient access permissions",
"description": "Insufficient access permissions",
"value": {
"errors": {
"code": "ERR_ACCESS_USER",
"message": "Insufficient access permissions"
}
}
}
}
}
}
},
"422": {
"description": "Unprocessable Content
Possible error codes: ERR_INPUT_INVALID_EMAIL, ERR_INPUT_REQUIRED",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
},
"examples": {
"ERR_INPUT_INVALID_EMAIL": {
"summary": "Input is not a valid email",
"description": "Input is not a valid email",
"value": {
"errors": {
"code": "ERR_INPUT_INVALID_EMAIL",
"message": "Input is not a valid email"
}
}
},
"ERR_INPUT_REQUIRED": {
"summary": "Field is required",
"description": "Field is required",
"value": {
"errors": {
"code": "ERR_INPUT_REQUIRED",
"message": "Field is required"
}
}
}
}
}
}
},
"490": {
"description": "Request blocked by WAF"
}
},
"deprecated": false,
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UserRequestPasswordReset.Post"
}
}
}
}
}
},
"/rest/users/resetPassword": {
"post": {
"tags": [
"users"
],
"summary": "Reset password",
"description": "Reset password of an existing user",
"responses": {
"204": {
"description": "Password reset request processed. A notification email may have been sent depending on the account state."
},
"403": {
"description": "Forbidden
Possible error codes: ERR_ACCESS_USER",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
},
"examples": {
"ERR_ACCESS_USER": {
"summary": "Insufficient access permissions",
"description": "Insufficient access permissions",
"value": {
"errors": {
"code": "ERR_ACCESS_USER",
"message": "Insufficient access permissions"
}
}
}
}
}
}
},
"422": {
"description": "Unprocessable Content
Possible error codes: ERR_INPUT_REQUIRED, ERR_INPUT_PASSWORD_COMPLEXITY_ERROR",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
},
"examples": {
"ERR_INPUT_REQUIRED": {
"summary": "Field is required",
"description": "Field is required",
"value": {
"errors": {
"code": "ERR_INPUT_REQUIRED",
"message": "Field is required"
}
}
},
"ERR_INPUT_PASSWORD_COMPLEXITY_ERROR": {
"summary": "Password does not meet complexity requirements",
"description": "Password does not meet complexity requirements",
"value": {
"errors": {
"code": "ERR_INPUT_PASSWORD_COMPLEXITY_ERROR",
"message": "Password does not meet complexity requirements"
}
}
}
}
}
}
},
"490": {
"description": "Request blocked by WAF"
}
},
"deprecated": false,
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UserResetPassword.Post"
}
}
}
}
}
},
"/rest/users/{id}/devices": {
"get": {
"tags": [
"devices"
],
"summary": "List devices for a user",
"description": "Returns a list of devices registered to the specified user.",
"responses": {
"200": {
"description": "Returns a paginated list of device records for the specified user.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Device"
}
},
"metadata": {
"$ref": "#/components/schemas/MetaData"
}
}
},
"examples": {
"User device list": {
"summary": "Devices registered to a user",
"value": {
"data": [
{
"id": 101,
"client_id": "mobile_app_ios",
"user_id": 5,
"install_tag_id": "ABC123DEF456",
"install_name": "Work iPhone",
"wipe_flag": 0,
"mobile_key_store": null
}
],
"total": 1,
"page": 1,
"pageSize": 20
}
}
}
}
}
},
"490": {
"description": "Request blocked by WAF"
}
},
"deprecated": false,
"parameters": [
{
"in": "path",
"name": "id",
"description": "ID of the user whose devices to be retrieved",
"required": true,
"schema": {
"type": "string"
}
}
]
}
},
"/rest/users/{id}/profileImage": {
"post": {
"tags": [
"users"
],
"summary": "Uploads a profile image",
"description": "Uploads an image file to use as profile image",
"responses": {
"200": {
"description": "Profile image uploaded successfully.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Settings"
},
"examples": {
"SettingsAfterUpload": {
"summary": "User settings after profile image upload",
"value": {
"id": 42,
"userId": 101,
"languageId": 1,
"storageUsed": 204800,
"storageQuota": 1073741824,
"profileIconId": 55,
"mobileNumber": "+1-5551234567",
"mobileNumberVerified": false
}
}
}
}
}
},
"403": {
"description": "Forbidden
Possible error codes: ERR_ACCESS_USER",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
},
"examples": {
"ERR_ACCESS_USER": {
"summary": "Insufficient access permissions",
"description": "Insufficient access permissions",
"value": {
"errors": {
"code": "ERR_ACCESS_USER",
"message": "Insufficient access permissions"
}
}
}
}
}
}
},
"490": {
"description": "Request blocked by WAF"
}
},
"deprecated": false,
"parameters": [
{
"in": "path",
"name": "id",
"description": "The unique identifier of the user.",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"multipart/form-data": {
"schema": {
"type": "object",
"properties": {
"body": {
"description": "The binary content of the file.",
"type": "string",
"format": "binary"
}
},
"required": [
"body"
]
}
}
}
}
},
"delete": {
"tags": [
"users"
],
"summary": "Deletes a profile image",
"description": "Deletes the user's current profile image.",
"responses": {
"200": {
"description": "Profile image deleted successfully.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Settings"
},
"examples": {
"SettingsAfterDelete": {
"summary": "User settings after profile image deletion",
"value": {
"id": 42,
"userId": 101,
"languageId": 1,
"storageUsed": 204800,
"storageQuota": 1073741824,
"profileIconId": null,
"mobileNumber": "+1-5551234567",
"mobileNumberVerified": false
}
}
}
}
}
},
"403": {
"description": "Forbidden
Possible error codes: ERR_ACCESS_USER",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
},
"examples": {
"ERR_ACCESS_USER": {
"summary": "Insufficient access permissions",
"description": "Insufficient access permissions",
"value": {
"errors": {
"code": "ERR_ACCESS_USER",
"message": "Insufficient access permissions"
}
}
}
}
}
}
},
"490": {
"description": "Request blocked by WAF"
}
},
"deprecated": false,
"parameters": [
{
"in": "path",
"name": "id",
"description": "The unique identifier of the user.",
"required": true,
"schema": {
"type": "string"
}
}
]
}
},
"/rest/users/{id}/settings": {
"get": {
"tags": [
"users"
],
"summary": "Get User Settings",
"description": "Returns the settings for the specified user, including language preference, location, email signature, storage usage, and mobile number. Users can only retrieve their own settings.",
"responses": {
"200": {
"description": "User settings returned successfully.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Settings"
},
"examples": {
"UserSettings": {
"summary": "Settings for a user",
"value": {
"languageId": 1,
"locationId": 2,
"signature": "Best regards
",
"storageUsed": 1048576,
"storageQuota": 10737418240,
"mobileNumber": "+14155550100",
"mobileNumberVerified": true
}
}
}
}
}
},
"403": {
"description": "Forbidden
Possible error codes: ERR_ACCESS_USER",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
},
"examples": {
"ERR_ACCESS_USER": {
"summary": "Insufficient access permissions",
"description": "Insufficient access permissions",
"value": {
"errors": {
"code": "ERR_ACCESS_USER",
"message": "Insufficient access permissions"
}
}
}
}
}
}
},
"490": {
"description": "Request blocked by WAF"
}
},
"deprecated": false,
"parameters": [
{
"in": "path",
"name": "id",
"description": "ID of the user to retrieve settings for",
"required": true,
"schema": {
"type": "string"
}
}
]
},
"put": {
"tags": [
"users"
],
"summary": "Update User Settings",
"description": "Updates the settings for the specified user, including language preference, location, email signature, and timezone. Users can only update their own settings. Returns 400 if the location cannot be changed because it is managed by an LDAP/SSO mapping.",
"responses": {
"200": {
"description": "User settings updated successfully.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Settings"
},
"examples": {
"SettingsUpdated": {
"summary": "Settings after update",
"value": {
"languageId": 2,
"locationId": 3,
"signature": "Regards
",
"storageUsed": 2097152,
"storageQuota": 10737418240,
"mobileNumber": "+14155550100",
"mobileNumberVerified": true
}
}
}
}
}
},
"403": {
"description": "Forbidden
Possible error codes: ERR_ACCESS_USER",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
},
"examples": {
"ERR_ACCESS_USER": {
"summary": "Insufficient access permissions",
"description": "Insufficient access permissions",
"value": {
"errors": {
"code": "ERR_ACCESS_USER",
"message": "Insufficient access permissions"
}
}
}
}
}
}
},
"490": {
"description": "Request blocked by WAF"
}
},
"deprecated": false,
"parameters": [
{
"in": "path",
"name": "id",
"description": "ID of the user to update settings for",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Settings.Put"
}
}
}
}
}
},
"/rest/webForms": {
"get": {
"tags": [
"webForms"
],
"summary": "List web forms",
"description": "Returns a list of web forms available to the authenticated user's profile, including each form's name, URL, authentication requirement, and enabled state.",
"responses": {
"200": {
"description": "List of web forms retrieved successfully.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/WebForm"
}
}
}
},
"examples": {
"WebFormList": {
"summary": "List of web forms",
"value": {
"data": [
{
"id": "wf-001",
"name": "Contact Form",
"description": "General contact form",
"url": "https://example.com/forms/contact",
"authRequired": false,
"enabled": true,
"embedded": false,
"standalone": true,
"lastModified": "2024-03-01T10:00:00+00:00"
}
]
}
}
}
}
}
},
"490": {
"description": "Request blocked by WAF"
}
},
"deprecated": false,
"parameters": [
{
"in": "query",
"name": "name",
"description": "Web form name",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "name:contains",
"description": "Web form name. Search for results that contain the specified characters in this parameter.",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "orderBy",
"description": "Sorting options",
"schema": {
"type": "array",
"items": {
"type": "string"
},
"enum": [
"name:asc",
"name:desc",
"last_modified:asc",
"last_modified:desc"
]
}
},
{
"in": "query",
"name": "with",
"description": "With parameters",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "mode",
"description": "Determines the detail level of the response body.",
"schema": {
"type": "string",
"enum": [
"full_with_links",
"full"
]
}
}
]
}
},
"/rest/webForms/{id}": {
"get": {
"tags": [
"webForms"
],
"summary": "Get a web form",
"description": "Returns the details of the specified web form, including its name, URL, authentication requirement, enabled state, and associated fields. Accessible by both authenticated and unauthenticated users, subject to the form's access rules.",
"responses": {
"200": {
"description": "Web form details retrieved successfully.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WebForm"
},
"examples": {
"WebFormInfo": {
"summary": "Details of a single web form",
"value": {
"id": "wf-001",
"name": "Contact Form",
"description": "General contact form",
"url": "https://example.com/forms/contact",
"authRequired": false,
"enabled": true,
"embedded": false,
"standalone": true,
"lastModified": "2024-03-01T10:00:00+00:00"
}
}
}
}
}
},
"403": {
"description": "Forbidden
Possible error codes: ERR_ACCESS_USER",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
},
"examples": {
"ERR_ACCESS_USER": {
"summary": "Insufficient access permissions",
"description": "Insufficient access permissions",
"value": {
"errors": {
"code": "ERR_ACCESS_USER",
"message": "Insufficient access permissions"
}
}
}
}
}
}
},
"490": {
"description": "Request blocked by WAF"
}
},
"deprecated": false,
"parameters": [
{
"in": "path",
"name": "id",
"description": "ID of the web form to be retrieved",
"required": true,
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "with",
"description": "With parameters",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "mode",
"description": "Determines the detail level of the response body.",
"schema": {
"type": "string",
"enum": [
"full_with_links",
"full"
]
}
}
]
}
},
"/rest/files/actions/content/link/{ref}": {
"get": {
"summary": "Download a file via a reference link",
"description": "### Description:\n Downloads the file identified by the provided reference link.\n### Precondition:\n Must be assigned the `download` permission for the file.\n### Response:\n The file content is streamed to the user.\n",
"tags": [
"files"
],
"parameters": [
{
"in": "path",
"name": "ref",
"required": true,
"description": "The unique reference for the download link.",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "The file download request by reference link was successful.",
"content": {
"application/octet-stream": {
"schema": {
"type": "string",
"format": "binary"
}
}
}
},
"401": {
"description": "Unauthorized
Possible error codes: ERR_AUTH_UNAUTHORIZED",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
},
"examples": {
"ERR_AUTH_UNAUTHORIZED": {
"summary": "Unauthorized",
"description": "Unauthorized",
"value": {
"errors": [
{
"code": "ERR_AUTH_UNAUTHORIZED",
"message": "Unauthorized"
}
]
}
}
}
}
}
},
"403": {
"description": "Forbidden
Possible error codes: ERR_ACCESS_USER, ERR_ENTITY_DELETED, ERR_ENTITY_DLP_LOCKED, ERR_ENTITY_IS_SECURE_FOLDER, ERR_ENTITY_NOT_SCANNED, ERR_ENTITY_VIRUS_FOUND",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
},
"examples": {
"ERR_ACCESS_USER": {
"summary": "Insufficient access permissions",
"description": "Insufficient access permissions",
"value": {
"errors": [
{
"code": "ERR_ACCESS_USER",
"message": "Insufficient access permissions"
}
]
}
},
"ERR_ENTITY_DELETED": {
"summary": "Entity is deleted",
"description": "Entity is deleted",
"value": {
"errors": [
{
"code": "ERR_ENTITY_DELETED",
"message": "Entity is deleted"
}
]
}
},
"ERR_ENTITY_DLP_LOCKED": {
"summary": "One or more files have been quarantined and are not available to download. Please contact your administrator for assistance.",
"description": "One or more files have been quarantined and are not available to download. Please contact your administrator for assistance.",
"value": {
"errors": [
{
"code": "ERR_ENTITY_DLP_LOCKED",
"message": "One or more files have been quarantined and are not available to download. Please contact your administrator for assistance."
}
]
}
},
"ERR_ENTITY_IS_SECURE_FOLDER": {
"summary": "Operation not permitted on restricted Folder.",
"description": "Operation not permitted on restricted Folder.",
"value": {
"errors": [
{
"code": "ERR_ENTITY_IS_SECURE_FOLDER",
"message": "Operation not permitted on restricted Folder."
}
]
}
},
"ERR_ENTITY_NOT_SCANNED": {
"summary": "One or more files are undergoing security and privacy scans. Please try again later.",
"description": "One or more files are undergoing security and privacy scans. Please try again later.",
"value": {
"errors": [
{
"code": "ERR_ENTITY_NOT_SCANNED",
"message": "One or more files are undergoing security and privacy scans. Please try again later."
}
]
}
},
"ERR_ENTITY_VIRUS_FOUND": {
"summary": "File is infected",
"description": "File is infected",
"value": {
"errors": [
{
"code": "ERR_ENTITY_VIRUS_FOUND",
"message": "File is infected"
}
]
}
}
}
}
}
},
"490": {
"description": "Request blocked by WAF"
}
}
}
},
"/rest/folders/{id}/actions/initiateUpload/zip": {
"post": {
"summary": "Initiate a ZIP archive upload session for a folder",
"description": "### Description:\n Creates an upload session for a ZIP archive to be uploaded to the specified folder. The archive will be automatically extracted after all chunks are received. Once the session is created, an upload link is returned which can be used to upload the archive in chunks.\n### Precondition:\n The user must have `file_add` permission for the folder.\n### Response:\n The upload session is created and an upload link is returned for subsequent chunk uploads.\n",
"tags": [
"uploads"
],
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"description": "The unique identifier (UUID) of the entity.",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InitiateUploadZipPostRequest"
}
}
}
},
"responses": {
"201": {
"description": "Upload session successfully created and an upload link returned.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Upload"
}
}
}
},
"400": {
"description": "Bad Request
Possible error codes: ERR_REQUEST_INVALID_JSON",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
},
"examples": {
"ERR_REQUEST_INVALID_JSON": {
"summary": "Invalid json provided",
"description": "Invalid json provided",
"value": {
"errors": [
{
"code": "ERR_REQUEST_INVALID_JSON",
"message": "Invalid json provided"
}
]
}
}
}
}
}
},
"401": {
"description": "Unauthorized
Possible error codes: ERR_AUTH_INVALID_CSRF, ERR_AUTH_UNAUTHORIZED",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
},
"examples": {
"ERR_AUTH_INVALID_CSRF": {
"summary": "Invalid CSRF Authentication",
"description": "Invalid CSRF Authentication",
"value": {
"errors": [
{
"code": "ERR_AUTH_INVALID_CSRF",
"message": "Invalid CSRF Authentication"
}
]
}
},
"ERR_AUTH_UNAUTHORIZED": {
"summary": "Unauthorized",
"description": "Unauthorized",
"value": {
"errors": [
{
"code": "ERR_AUTH_UNAUTHORIZED",
"message": "Unauthorized"
}
]
}
}
}
}
}
},
"403": {
"description": "Forbidden
Possible error codes: ERR_ACCESS_USER, ERR_ENTITY_DLP_LOCKED, ERR_ENTITY_IS_BASE_DIR, ERR_ENTITY_NOT_SCANNED, ERR_ENTITY_RESTRICTED_EXTENSION, ERR_ENTITY_VIRUS_FOUND",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
},
"examples": {
"ERR_ACCESS_USER": {
"summary": "Insufficient access permissions",
"description": "Insufficient access permissions",
"value": {
"errors": [
{
"code": "ERR_ACCESS_USER",
"message": "Insufficient access permissions"
}
]
}
},
"ERR_ENTITY_DLP_LOCKED": {
"summary": "One or more files have been quarantined and are not available to download. Please contact your administrator for assistance.",
"description": "One or more files have been quarantined and are not available to download. Please contact your administrator for assistance.",
"value": {
"errors": [
{
"code": "ERR_ENTITY_DLP_LOCKED",
"message": "One or more files have been quarantined and are not available to download. Please contact your administrator for assistance."
}
]
}
},
"ERR_ENTITY_IS_BASE_DIR": {
"summary": "Operation not permitted on Base Folder",
"description": "Operation not permitted on Base Folder",
"value": {
"errors": [
{
"code": "ERR_ENTITY_IS_BASE_DIR",
"message": "Operation not permitted on Base Folder"
}
]
}
},
"ERR_ENTITY_NOT_SCANNED": {
"summary": "One or more files are undergoing security and privacy scans. Please try again later.",
"description": "One or more files are undergoing security and privacy scans. Please try again later.",
"value": {
"errors": [
{
"code": "ERR_ENTITY_NOT_SCANNED",
"message": "One or more files are undergoing security and privacy scans. Please try again later."
}
]
}
},
"ERR_ENTITY_RESTRICTED_EXTENSION": {
"summary": "File extension is in exclusion extensions list",
"description": "File extension is in exclusion extensions list",
"value": {
"errors": [
{
"code": "ERR_ENTITY_RESTRICTED_EXTENSION",
"message": "File extension is in exclusion extensions list"
}
]
}
},
"ERR_ENTITY_VIRUS_FOUND": {
"summary": "File is infected",
"description": "File is infected",
"value": {
"errors": [
{
"code": "ERR_ENTITY_VIRUS_FOUND",
"message": "File is infected"
}
]
}
}
}
}
}
},
"413": {
"description": "Content Too Large
Possible error codes: ERR_SYSTEM_NO_STORAGE_AVAILABLE",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
},
"examples": {
"ERR_SYSTEM_NO_STORAGE_AVAILABLE": {
"summary": "Folder owner's remaining storage quota does not permit for a file upload of this size.",
"description": "Folder owner's remaining storage quota does not permit for a file upload of this size.",
"value": {
"errors": [
{
"code": "ERR_SYSTEM_NO_STORAGE_AVAILABLE",
"message": "Folder owner's remaining storage quota does not permit for a file upload of this size."
}
]
}
}
}
}
}
},
"422": {
"description": "Unprocessable Content
Possible error codes: ERR_INPUT_INVALID_DATE, ERR_INPUT_INVALID_FORMAT, ERR_INPUT_MAX_VALUE, ERR_INPUT_MIN_VALUE, ERR_INVALID_PARAMETER, ERR_SYSTEM_NO_STORAGE_AVAILABLE, ERR_SYSTEM_NO_AVAILABLE_STORAGE_HOSTS",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
},
"examples": {
"ERR_INPUT_INVALID_DATE": {
"summary": "The input is not a valid date.",
"description": "The input is not a valid date.",
"value": {
"errors": [
{
"code": "ERR_INPUT_INVALID_DATE",
"message": "The input is not a valid date."
}
]
}
},
"ERR_INPUT_INVALID_FORMAT": {
"summary": "The input is invalid.",
"description": "The input is invalid.",
"value": {
"errors": [
{
"code": "ERR_INPUT_INVALID_FORMAT",
"message": "The input is invalid."
}
]
}
},
"ERR_INPUT_MAX_VALUE": {
"summary": "The specified input exceed the maximum allowed value.",
"description": "The specified input exceed the maximum allowed value.",
"value": {
"errors": [
{
"code": "ERR_INPUT_MAX_VALUE",
"message": "The specified input exceed the maximum allowed value."
}
]
}
},
"ERR_INPUT_MIN_VALUE": {
"summary": "The specified input below the minimum allowed value.",
"description": "The specified input below the minimum allowed value.",
"value": {
"errors": [
{
"code": "ERR_INPUT_MIN_VALUE",
"message": "The specified input below the minimum allowed value."
}
]
}
},
"ERR_INVALID_PARAMETER": {
"summary": "Invalid Parameter Exception",
"description": "Invalid Parameter Exception",
"value": {
"errors": [
{
"code": "ERR_INVALID_PARAMETER",
"message": "Invalid Parameter Exception"
}
]
}
},
"ERR_SYSTEM_NO_STORAGE_AVAILABLE": {
"summary": "Folder owner's remaining storage quota does not permit for a file upload of this size.",
"description": "Folder owner's remaining storage quota does not permit for a file upload of this size.",
"value": {
"errors": [
{
"code": "ERR_SYSTEM_NO_STORAGE_AVAILABLE",
"message": "Folder owner's remaining storage quota does not permit for a file upload of this size."
}
]
}
},
"ERR_SYSTEM_NO_AVAILABLE_STORAGE_HOSTS": {
"summary": "No available storage hosts",
"description": "No available storage hosts",
"value": {
"errors": [
{
"code": "ERR_SYSTEM_NO_AVAILABLE_STORAGE_HOSTS",
"message": "No available storage hosts"
}
]
}
}
}
}
}
},
"490": {
"description": "Request blocked by WAF"
}
}
}
},
"/rest/folders/{id}/actions/initiateUpload": {
"post": {
"summary": "Initiate a file upload session for a folder",
"description": "### Description:\n Creates an upload session for a file to be added to the specified folder. Once the session is created, an upload link is returned which can be used to upload the file in chunks.\n### Precondition:\n The user must have `file_add` permission for the folder.\n### Response:\n The upload session is created and an upload link is returned for subsequent chunk uploads.\n",
"tags": [
"uploads"
],
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"description": "The unique identifier (UUID) of the entity.",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InitiateUploadPostRequest"
}
}
}
},
"responses": {
"201": {
"description": "Upload session successfully created and an upload link returned.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Upload"
}
}
}
},
"400": {
"description": "Bad Request
Possible error codes: ERR_REQUEST_INVALID_JSON",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
},
"examples": {
"ERR_REQUEST_INVALID_JSON": {
"summary": "Invalid json provided",
"description": "Invalid json provided",
"value": {
"errors": [
{
"code": "ERR_REQUEST_INVALID_JSON",
"message": "Invalid json provided"
}
]
}
}
}
}
}
},
"401": {
"description": "Unauthorized
Possible error codes: ERR_AUTH_INVALID_CSRF, ERR_AUTH_UNAUTHORIZED",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
},
"examples": {
"ERR_AUTH_INVALID_CSRF": {
"summary": "Invalid CSRF Authentication",
"description": "Invalid CSRF Authentication",
"value": {
"errors": [
{
"code": "ERR_AUTH_INVALID_CSRF",
"message": "Invalid CSRF Authentication"
}
]
}
},
"ERR_AUTH_UNAUTHORIZED": {
"summary": "Unauthorized",
"description": "Unauthorized",
"value": {
"errors": [
{
"code": "ERR_AUTH_UNAUTHORIZED",
"message": "Unauthorized"
}
]
}
}
}
}
}
},
"403": {
"description": "Forbidden
Possible error codes: ERR_ACCESS_USER, ERR_ENTITY_DLP_LOCKED, ERR_ENTITY_IS_BASE_DIR, ERR_ENTITY_NOT_SCANNED, ERR_ENTITY_RESTRICTED_EXTENSION, ERR_ENTITY_VIRUS_FOUND",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
},
"examples": {
"ERR_ACCESS_USER": {
"summary": "Insufficient access permissions",
"description": "Insufficient access permissions",
"value": {
"errors": [
{
"code": "ERR_ACCESS_USER",
"message": "Insufficient access permissions"
}
]
}
},
"ERR_ENTITY_DLP_LOCKED": {
"summary": "One or more files have been quarantined and are not available to download. Please contact your administrator for assistance.",
"description": "One or more files have been quarantined and are not available to download. Please contact your administrator for assistance.",
"value": {
"errors": [
{
"code": "ERR_ENTITY_DLP_LOCKED",
"message": "One or more files have been quarantined and are not available to download. Please contact your administrator for assistance."
}
]
}
},
"ERR_ENTITY_IS_BASE_DIR": {
"summary": "Operation not permitted on Base Folder",
"description": "Operation not permitted on Base Folder",
"value": {
"errors": [
{
"code": "ERR_ENTITY_IS_BASE_DIR",
"message": "Operation not permitted on Base Folder"
}
]
}
},
"ERR_ENTITY_NOT_SCANNED": {
"summary": "One or more files are undergoing security and privacy scans. Please try again later.",
"description": "One or more files are undergoing security and privacy scans. Please try again later.",
"value": {
"errors": [
{
"code": "ERR_ENTITY_NOT_SCANNED",
"message": "One or more files are undergoing security and privacy scans. Please try again later."
}
]
}
},
"ERR_ENTITY_RESTRICTED_EXTENSION": {
"summary": "File extension is in exclusion extensions list",
"description": "File extension is in exclusion extensions list",
"value": {
"errors": [
{
"code": "ERR_ENTITY_RESTRICTED_EXTENSION",
"message": "File extension is in exclusion extensions list"
}
]
}
},
"ERR_ENTITY_VIRUS_FOUND": {
"summary": "File is infected",
"description": "File is infected",
"value": {
"errors": [
{
"code": "ERR_ENTITY_VIRUS_FOUND",
"message": "File is infected"
}
]
}
}
}
}
}
},
"413": {
"description": "Content Too Large
Possible error codes: ERR_SYSTEM_NO_STORAGE_AVAILABLE",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
},
"examples": {
"ERR_SYSTEM_NO_STORAGE_AVAILABLE": {
"summary": "Folder owner's remaining storage quota does not permit for a file upload of this size.",
"description": "Folder owner's remaining storage quota does not permit for a file upload of this size.",
"value": {
"errors": [
{
"code": "ERR_SYSTEM_NO_STORAGE_AVAILABLE",
"message": "Folder owner's remaining storage quota does not permit for a file upload of this size."
}
]
}
}
}
}
}
},
"422": {
"description": "Unprocessable Content
Possible error codes: ERR_INPUT_INVALID_DATE, ERR_INPUT_INVALID_FORMAT, ERR_INPUT_MAX_VALUE, ERR_INPUT_MIN_VALUE, ERR_INVALID_PARAMETER, ERR_SYSTEM_NO_STORAGE_AVAILABLE, ERR_SYSTEM_NO_AVAILABLE_STORAGE_HOSTS",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
},
"examples": {
"ERR_INPUT_INVALID_DATE": {
"summary": "The input is not a valid date.",
"description": "The input is not a valid date.",
"value": {
"errors": [
{
"code": "ERR_INPUT_INVALID_DATE",
"message": "The input is not a valid date."
}
]
}
},
"ERR_INPUT_INVALID_FORMAT": {
"summary": "The input is invalid.",
"description": "The input is invalid.",
"value": {
"errors": [
{
"code": "ERR_INPUT_INVALID_FORMAT",
"message": "The input is invalid."
}
]
}
},
"ERR_INPUT_MAX_VALUE": {
"summary": "The specified input exceed the maximum allowed value.",
"description": "The specified input exceed the maximum allowed value.",
"value": {
"errors": [
{
"code": "ERR_INPUT_MAX_VALUE",
"message": "The specified input exceed the maximum allowed value."
}
]
}
},
"ERR_INPUT_MIN_VALUE": {
"summary": "The specified input below the minimum allowed value.",
"description": "The specified input below the minimum allowed value.",
"value": {
"errors": [
{
"code": "ERR_INPUT_MIN_VALUE",
"message": "The specified input below the minimum allowed value."
}
]
}
},
"ERR_INVALID_PARAMETER": {
"summary": "Invalid Parameter Exception",
"description": "Invalid Parameter Exception",
"value": {
"errors": [
{
"code": "ERR_INVALID_PARAMETER",
"message": "Invalid Parameter Exception"
}
]
}
},
"ERR_SYSTEM_NO_STORAGE_AVAILABLE": {
"summary": "Folder owner's remaining storage quota does not permit for a file upload of this size.",
"description": "Folder owner's remaining storage quota does not permit for a file upload of this size.",
"value": {
"errors": [
{
"code": "ERR_SYSTEM_NO_STORAGE_AVAILABLE",
"message": "Folder owner's remaining storage quota does not permit for a file upload of this size."
}
]
}
},
"ERR_SYSTEM_NO_AVAILABLE_STORAGE_HOSTS": {
"summary": "No available storage hosts",
"description": "No available storage hosts",
"value": {
"errors": [
{
"code": "ERR_SYSTEM_NO_AVAILABLE_STORAGE_HOSTS",
"message": "No available storage hosts"
}
]
}
}
}
}
}
},
"490": {
"description": "Request blocked by WAF"
}
}
}
},
"/rest/requestFile/{ref}/actions/initiateUpload": {
"post": {
"summary": "Initiate a file upload session for a request file",
"description": "### Description:\n Creates an upload session for a file to be uploaded to a request file. Once the session is created, an upload link is returned which can be used to upload the file in chunks.\n### Precondition:\n The caller must have access to the request file for uploading.\n### Response:\n The upload session is created and an upload link is returned for subsequent chunk uploads.\n",
"tags": [
"uploads"
],
"parameters": [
{
"in": "path",
"name": "ref",
"required": true,
"description": "The unique reference of the Request File upload link.",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InitiateUploadPostRequest"
}
}
}
},
"responses": {
"201": {
"description": "Upload session successfully created and an upload link returned.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Upload"
}
}
}
},
"400": {
"description": "Bad Request
Possible error codes: ERR_REQUEST_INVALID_JSON",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
},
"examples": {
"ERR_REQUEST_INVALID_JSON": {
"summary": "Invalid json provided",
"description": "Invalid json provided",
"value": {
"errors": [
{
"code": "ERR_REQUEST_INVALID_JSON",
"message": "Invalid json provided"
}
]
}
}
}
}
}
},
"401": {
"description": "Unauthorized
Possible error codes: ERR_AUTH_INVALID_CSRF, ERR_AUTH_UNAUTHORIZED",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
},
"examples": {
"ERR_AUTH_INVALID_CSRF": {
"summary": "Invalid CSRF Authentication",
"description": "Invalid CSRF Authentication",
"value": {
"errors": [
{
"code": "ERR_AUTH_INVALID_CSRF",
"message": "Invalid CSRF Authentication"
}
]
}
},
"ERR_AUTH_UNAUTHORIZED": {
"summary": "Unauthorized",
"description": "Unauthorized",
"value": {
"errors": [
{
"code": "ERR_AUTH_UNAUTHORIZED",
"message": "Unauthorized"
}
]
}
}
}
}
}
},
"403": {
"description": "Forbidden
Possible error codes: ERR_ACCESS_USER, ERR_ENTITY_IS_BASE_DIR, ERR_ENTITY_REQUEST_FILE_UPLOAD_LIMIT_REACHED, ERR_ENTITY_RESTRICTED_EXTENSION",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
},
"examples": {
"ERR_ACCESS_USER": {
"summary": "Insufficient access permissions",
"description": "Insufficient access permissions",
"value": {
"errors": [
{
"code": "ERR_ACCESS_USER",
"message": "Insufficient access permissions"
}
]
}
},
"ERR_ENTITY_IS_BASE_DIR": {
"summary": "Operation not permitted on Base Folder",
"description": "Operation not permitted on Base Folder",
"value": {
"errors": [
{
"code": "ERR_ENTITY_IS_BASE_DIR",
"message": "Operation not permitted on Base Folder"
}
]
}
},
"ERR_ENTITY_REQUEST_FILE_UPLOAD_LIMIT_REACHED": {
"summary": "Upload limit has reached.",
"description": "Upload limit has reached.",
"value": {
"errors": [
{
"code": "ERR_ENTITY_REQUEST_FILE_UPLOAD_LIMIT_REACHED",
"message": "Upload limit has reached."
}
]
}
},
"ERR_ENTITY_RESTRICTED_EXTENSION": {
"summary": "File extension is in exclusion extensions list",
"description": "File extension is in exclusion extensions list",
"value": {
"errors": [
{
"code": "ERR_ENTITY_RESTRICTED_EXTENSION",
"message": "File extension is in exclusion extensions list"
}
]
}
}
}
}
}
},
"413": {
"description": "Content Too Large
Possible error codes: ERR_SYSTEM_NO_STORAGE_AVAILABLE",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
},
"examples": {
"ERR_SYSTEM_NO_STORAGE_AVAILABLE": {
"summary": "Folder owner's remaining storage quota does not permit for a file upload of this size.",
"description": "Folder owner's remaining storage quota does not permit for a file upload of this size.",
"value": {
"errors": [
{
"code": "ERR_SYSTEM_NO_STORAGE_AVAILABLE",
"message": "Folder owner's remaining storage quota does not permit for a file upload of this size."
}
]
}
}
}
}
}
},
"422": {
"description": "Unprocessable Content
Possible error codes: ERR_INPUT_INVALID_DATE, ERR_INPUT_INVALID_FORMAT, ERR_INPUT_MAX_VALUE, ERR_INPUT_MIN_VALUE, ERR_INVALID_PARAMETER, ERR_SYSTEM_NO_AVAILABLE_STORAGE_HOSTS",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
},
"examples": {
"ERR_INPUT_INVALID_DATE": {
"summary": "The input is not a valid date.",
"description": "The input is not a valid date.",
"value": {
"errors": [
{
"code": "ERR_INPUT_INVALID_DATE",
"message": "The input is not a valid date."
}
]
}
},
"ERR_INPUT_INVALID_FORMAT": {
"summary": "The input is invalid.",
"description": "The input is invalid.",
"value": {
"errors": [
{
"code": "ERR_INPUT_INVALID_FORMAT",
"message": "The input is invalid."
}
]
}
},
"ERR_INPUT_MAX_VALUE": {
"summary": "The specified input exceed the maximum allowed value.",
"description": "The specified input exceed the maximum allowed value.",
"value": {
"errors": [
{
"code": "ERR_INPUT_MAX_VALUE",
"message": "The specified input exceed the maximum allowed value."
}
]
}
},
"ERR_INPUT_MIN_VALUE": {
"summary": "The specified input below the minimum allowed value.",
"description": "The specified input below the minimum allowed value.",
"value": {
"errors": [
{
"code": "ERR_INPUT_MIN_VALUE",
"message": "The specified input below the minimum allowed value."
}
]
}
},
"ERR_INVALID_PARAMETER": {
"summary": "Invalid Parameter Exception",
"description": "Invalid Parameter Exception",
"value": {
"errors": [
{
"code": "ERR_INVALID_PARAMETER",
"message": "Invalid Parameter Exception"
}
]
}
},
"ERR_SYSTEM_NO_AVAILABLE_STORAGE_HOSTS": {
"summary": "No available storage hosts",
"description": "No available storage hosts",
"value": {
"errors": [
{
"code": "ERR_SYSTEM_NO_AVAILABLE_STORAGE_HOSTS",
"message": "No available storage hosts"
}
]
}
}
}
}
}
},
"490": {
"description": "Request blocked by WAF"
}
}
}
},
"/rest/mail/{id}/actions/initiateUpload": {
"post": {
"summary": "Initiate a file upload session for an email attachment",
"description": "### Description:\n Creates an upload session for a file to be attached to an email. Once the session is created, an upload link is returned which can be used to upload the attachment in chunks.\n### Precondition:\n The user must be the sender of the email.\n### Response:\n The upload session is created and an upload link is returned for subsequent chunk uploads.\n",
"tags": [
"uploads"
],
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"description": "The unique identifier (UUID) of the email.",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InitiateUploadPostRequest"
}
}
}
},
"responses": {
"201": {
"description": "Upload session successfully created and an upload link returned.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Upload"
}
}
}
},
"400": {
"description": "Bad Request
Possible error codes: ERR_REQUEST_INVALID_JSON",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
},
"examples": {
"ERR_REQUEST_INVALID_JSON": {
"summary": "Invalid json provided",
"description": "Invalid json provided",
"value": {
"errors": [
{
"code": "ERR_REQUEST_INVALID_JSON",
"message": "Invalid json provided"
}
]
}
}
}
}
}
},
"401": {
"description": "Unauthorized
Possible error codes: ERR_AUTH_INVALID_CSRF, ERR_AUTH_UNAUTHORIZED",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
},
"examples": {
"ERR_AUTH_INVALID_CSRF": {
"summary": "Invalid CSRF Authentication",
"description": "Invalid CSRF Authentication",
"value": {
"errors": [
{
"code": "ERR_AUTH_INVALID_CSRF",
"message": "Invalid CSRF Authentication"
}
]
}
},
"ERR_AUTH_UNAUTHORIZED": {
"summary": "Unauthorized",
"description": "Unauthorized",
"value": {
"errors": [
{
"code": "ERR_AUTH_UNAUTHORIZED",
"message": "Unauthorized"
}
]
}
}
}
}
}
},
"403": {
"description": "Forbidden
Possible error codes: ERR_ACCESS_USER, ERR_ENTITY_IS_BASE_DIR, ERR_ENTITY_RESTRICTED_EXTENSION",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
},
"examples": {
"ERR_ACCESS_USER": {
"summary": "Insufficient access permissions",
"description": "Insufficient access permissions",
"value": {
"errors": [
{
"code": "ERR_ACCESS_USER",
"message": "Insufficient access permissions"
}
]
}
},
"ERR_ENTITY_IS_BASE_DIR": {
"summary": "Operation not permitted on Base Folder",
"description": "Operation not permitted on Base Folder",
"value": {
"errors": [
{
"code": "ERR_ENTITY_IS_BASE_DIR",
"message": "Operation not permitted on Base Folder"
}
]
}
},
"ERR_ENTITY_RESTRICTED_EXTENSION": {
"summary": "File extension is in exclusion extensions list",
"description": "File extension is in exclusion extensions list",
"value": {
"errors": [
{
"code": "ERR_ENTITY_RESTRICTED_EXTENSION",
"message": "File extension is in exclusion extensions list"
}
]
}
}
}
}
}
},
"413": {
"description": "Content Too Large
Possible error codes: ERR_SYSTEM_NO_STORAGE_AVAILABLE",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
},
"examples": {
"ERR_SYSTEM_NO_STORAGE_AVAILABLE": {
"summary": "Folder owner's remaining storage quota does not permit for a file upload of this size.",
"description": "Folder owner's remaining storage quota does not permit for a file upload of this size.",
"value": {
"errors": [
{
"code": "ERR_SYSTEM_NO_STORAGE_AVAILABLE",
"message": "Folder owner's remaining storage quota does not permit for a file upload of this size."
}
]
}
}
}
}
}
},
"422": {
"description": "Unprocessable Content
Possible error codes: ERR_INPUT_INVALID_DATE, ERR_INPUT_INVALID_FORMAT, ERR_INPUT_MAX_VALUE, ERR_INPUT_MIN_VALUE, ERR_INVALID_PARAMETER, ERR_SYSTEM_NO_AVAILABLE_STORAGE_HOSTS",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
},
"examples": {
"ERR_INPUT_INVALID_DATE": {
"summary": "The input is not a valid date.",
"description": "The input is not a valid date.",
"value": {
"errors": [
{
"code": "ERR_INPUT_INVALID_DATE",
"message": "The input is not a valid date."
}
]
}
},
"ERR_INPUT_INVALID_FORMAT": {
"summary": "The input is invalid.",
"description": "The input is invalid.",
"value": {
"errors": [
{
"code": "ERR_INPUT_INVALID_FORMAT",
"message": "The input is invalid."
}
]
}
},
"ERR_INPUT_MAX_VALUE": {
"summary": "The specified input exceed the maximum allowed value.",
"description": "The specified input exceed the maximum allowed value.",
"value": {
"errors": [
{
"code": "ERR_INPUT_MAX_VALUE",
"message": "The specified input exceed the maximum allowed value."
}
]
}
},
"ERR_INPUT_MIN_VALUE": {
"summary": "The specified input below the minimum allowed value.",
"description": "The specified input below the minimum allowed value.",
"value": {
"errors": [
{
"code": "ERR_INPUT_MIN_VALUE",
"message": "The specified input below the minimum allowed value."
}
]
}
},
"ERR_INVALID_PARAMETER": {
"summary": "Invalid Parameter Exception",
"description": "Invalid Parameter Exception",
"value": {
"errors": [
{
"code": "ERR_INVALID_PARAMETER",
"message": "Invalid Parameter Exception"
}
]
}
},
"ERR_SYSTEM_NO_AVAILABLE_STORAGE_HOSTS": {
"summary": "No available storage hosts",
"description": "No available storage hosts",
"value": {
"errors": [
{
"code": "ERR_SYSTEM_NO_AVAILABLE_STORAGE_HOSTS",
"message": "No available storage hosts"
}
]
}
}
}
}
}
},
"490": {
"description": "Request blocked by WAF"
}
}
}
},
"/rest/public/mail/{id}/actions/initiateUpload": {
"post": {
"summary": "Initiate an unauthenticated file upload session for an email attachment",
"description": "### Description:\n Creates an upload session for a file to be attached to an email, without requiring full authentication. Once the session is created, an upload link is returned which can be used to upload the attachment in chunks.\n### Precondition:\n The caller must have a valid unauthenticated access context for the specified email.\n### Response:\n The upload session is created and an upload link is returned for subsequent chunk uploads.\n",
"tags": [
"uploads"
],
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"description": "The unique identifier (UUID) of the email.",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InitiateUploadPostRequest"
}
}
}
},
"responses": {
"201": {
"description": "Upload session successfully created and an upload link returned.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Upload"
}
}
}
},
"400": {
"description": "Bad Request
Possible error codes: ERR_REQUEST_INVALID_JSON",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
},
"examples": {
"ERR_REQUEST_INVALID_JSON": {
"summary": "Invalid json provided",
"description": "Invalid json provided",
"value": {
"errors": [
{
"code": "ERR_REQUEST_INVALID_JSON",
"message": "Invalid json provided"
}
]
}
}
}
}
}
},
"401": {
"description": "Unauthorized
Possible error codes: ERR_AUTH_INVALID_CSRF, ERR_AUTH_UNAUTHORIZED",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
},
"examples": {
"ERR_AUTH_INVALID_CSRF": {
"summary": "Invalid CSRF Authentication",
"description": "Invalid CSRF Authentication",
"value": {
"errors": [
{
"code": "ERR_AUTH_INVALID_CSRF",
"message": "Invalid CSRF Authentication"
}
]
}
},
"ERR_AUTH_UNAUTHORIZED": {
"summary": "Unauthorized",
"description": "Unauthorized",
"value": {
"errors": [
{
"code": "ERR_AUTH_UNAUTHORIZED",
"message": "Unauthorized"
}
]
}
}
}
}
}
},
"403": {
"description": "Forbidden
Possible error codes: ERR_ACCESS_USER, ERR_ENTITY_IS_BASE_DIR, ERR_ENTITY_RESTRICTED_EXTENSION",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
},
"examples": {
"ERR_ACCESS_USER": {
"summary": "Insufficient access permissions",
"description": "Insufficient access permissions",
"value": {
"errors": [
{
"code": "ERR_ACCESS_USER",
"message": "Insufficient access permissions"
}
]
}
},
"ERR_ENTITY_IS_BASE_DIR": {
"summary": "Operation not permitted on Base Folder",
"description": "Operation not permitted on Base Folder",
"value": {
"errors": [
{
"code": "ERR_ENTITY_IS_BASE_DIR",
"message": "Operation not permitted on Base Folder"
}
]
}
},
"ERR_ENTITY_RESTRICTED_EXTENSION": {
"summary": "File extension is in exclusion extensions list",
"description": "File extension is in exclusion extensions list",
"value": {
"errors": [
{
"code": "ERR_ENTITY_RESTRICTED_EXTENSION",
"message": "File extension is in exclusion extensions list"
}
]
}
}
}
}
}
},
"413": {
"description": "Content Too Large
Possible error codes: ERR_SYSTEM_NO_STORAGE_AVAILABLE",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
},
"examples": {
"ERR_SYSTEM_NO_STORAGE_AVAILABLE": {
"summary": "Folder owner's remaining storage quota does not permit for a file upload of this size.",
"description": "Folder owner's remaining storage quota does not permit for a file upload of this size.",
"value": {
"errors": [
{
"code": "ERR_SYSTEM_NO_STORAGE_AVAILABLE",
"message": "Folder owner's remaining storage quota does not permit for a file upload of this size."
}
]
}
}
}
}
}
},
"422": {
"description": "Unprocessable Content
Possible error codes: ERR_INPUT_INVALID_DATE, ERR_INPUT_INVALID_FORMAT, ERR_INPUT_MAX_VALUE, ERR_INPUT_MIN_VALUE, ERR_INVALID_PARAMETER, ERR_SYSTEM_NO_AVAILABLE_STORAGE_HOSTS",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
},
"examples": {
"ERR_INPUT_INVALID_DATE": {
"summary": "The input is not a valid date.",
"description": "The input is not a valid date.",
"value": {
"errors": [
{
"code": "ERR_INPUT_INVALID_DATE",
"message": "The input is not a valid date."
}
]
}
},
"ERR_INPUT_INVALID_FORMAT": {
"summary": "The input is invalid.",
"description": "The input is invalid.",
"value": {
"errors": [
{
"code": "ERR_INPUT_INVALID_FORMAT",
"message": "The input is invalid."
}
]
}
},
"ERR_INPUT_MAX_VALUE": {
"summary": "The specified input exceed the maximum allowed value.",
"description": "The specified input exceed the maximum allowed value.",
"value": {
"errors": [
{
"code": "ERR_INPUT_MAX_VALUE",
"message": "The specified input exceed the maximum allowed value."
}
]
}
},
"ERR_INPUT_MIN_VALUE": {
"summary": "The specified input below the minimum allowed value.",
"description": "The specified input below the minimum allowed value.",
"value": {
"errors": [
{
"code": "ERR_INPUT_MIN_VALUE",
"message": "The specified input below the minimum allowed value."
}
]
}
},
"ERR_INVALID_PARAMETER": {
"summary": "Invalid Parameter Exception",
"description": "Invalid Parameter Exception",
"value": {
"errors": [
{
"code": "ERR_INVALID_PARAMETER",
"message": "Invalid Parameter Exception"
}
]
}
},
"ERR_SYSTEM_NO_AVAILABLE_STORAGE_HOSTS": {
"summary": "No available storage hosts",
"description": "No available storage hosts",
"value": {
"errors": [
{
"code": "ERR_SYSTEM_NO_AVAILABLE_STORAGE_HOSTS",
"message": "No available storage hosts"
}
]
}
}
}
}
}
},
"490": {
"description": "Request blocked by WAF"
}
}
}
},
"/rest/files/{id}/actions/initiateUpload": {
"post": {
"summary": "Initiate an upload session for a new file version",
"description": "### Description:\n Creates an upload session to add a new version of an existing file. Once the session is created, an upload link is returned which can be used to upload the new version in chunks.\n### Precondition:\n The user must have `version_created` permission for the specified file.\n### Response:\n The upload session is created and an upload link is returned for subsequent chunk uploads.\n",
"tags": [
"uploads"
],
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"description": "The unique identifier (UUID) of the entity.",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InitiateUploadPostRequest"
}
}
}
},
"responses": {
"201": {
"description": "Upload session successfully created and an upload link returned.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Upload"
}
}
}
},
"400": {
"description": "Bad Request
Possible error codes: ERR_REQUEST_INVALID_JSON",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
},
"examples": {
"ERR_REQUEST_INVALID_JSON": {
"summary": "Invalid json provided",
"description": "Invalid json provided",
"value": {
"errors": [
{
"code": "ERR_REQUEST_INVALID_JSON",
"message": "Invalid json provided"
}
]
}
}
}
}
}
},
"401": {
"description": "Unauthorized
Possible error codes: ERR_AUTH_INVALID_CSRF, ERR_AUTH_UNAUTHORIZED",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
},
"examples": {
"ERR_AUTH_INVALID_CSRF": {
"summary": "Invalid CSRF Authentication",
"description": "Invalid CSRF Authentication",
"value": {
"errors": [
{
"code": "ERR_AUTH_INVALID_CSRF",
"message": "Invalid CSRF Authentication"
}
]
}
},
"ERR_AUTH_UNAUTHORIZED": {
"summary": "Unauthorized",
"description": "Unauthorized",
"value": {
"errors": [
{
"code": "ERR_AUTH_UNAUTHORIZED",
"message": "Unauthorized"
}
]
}
}
}
}
}
},
"403": {
"description": "Forbidden
Possible error codes: ERR_ACCESS_USER, ERR_ENTITY_DLP_LOCKED, ERR_ENTITY_IS_BASE_DIR, ERR_ENTITY_NOT_SCANNED, ERR_ENTITY_RESTRICTED_EXTENSION, ERR_ENTITY_VIRUS_FOUND",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
},
"examples": {
"ERR_ACCESS_USER": {
"summary": "Insufficient access permissions",
"description": "Insufficient access permissions",
"value": {
"errors": [
{
"code": "ERR_ACCESS_USER",
"message": "Insufficient access permissions"
}
]
}
},
"ERR_ENTITY_DLP_LOCKED": {
"summary": "One or more files have been quarantined and are not available to download. Please contact your administrator for assistance.",
"description": "One or more files have been quarantined and are not available to download. Please contact your administrator for assistance.",
"value": {
"errors": [
{
"code": "ERR_ENTITY_DLP_LOCKED",
"message": "One or more files have been quarantined and are not available to download. Please contact your administrator for assistance."
}
]
}
},
"ERR_ENTITY_IS_BASE_DIR": {
"summary": "Operation not permitted on Base Folder",
"description": "Operation not permitted on Base Folder",
"value": {
"errors": [
{
"code": "ERR_ENTITY_IS_BASE_DIR",
"message": "Operation not permitted on Base Folder"
}
]
}
},
"ERR_ENTITY_NOT_SCANNED": {
"summary": "One or more files are undergoing security and privacy scans. Please try again later.",
"description": "One or more files are undergoing security and privacy scans. Please try again later.",
"value": {
"errors": [
{
"code": "ERR_ENTITY_NOT_SCANNED",
"message": "One or more files are undergoing security and privacy scans. Please try again later."
}
]
}
},
"ERR_ENTITY_RESTRICTED_EXTENSION": {
"summary": "File extension is in exclusion extensions list",
"description": "File extension is in exclusion extensions list",
"value": {
"errors": [
{
"code": "ERR_ENTITY_RESTRICTED_EXTENSION",
"message": "File extension is in exclusion extensions list"
}
]
}
},
"ERR_ENTITY_VIRUS_FOUND": {
"summary": "File is infected",
"description": "File is infected",
"value": {
"errors": [
{
"code": "ERR_ENTITY_VIRUS_FOUND",
"message": "File is infected"
}
]
}
}
}
}
}
},
"413": {
"description": "Content Too Large
Possible error codes: ERR_SYSTEM_NO_STORAGE_AVAILABLE",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
},
"examples": {
"ERR_SYSTEM_NO_STORAGE_AVAILABLE": {
"summary": "Folder owner's remaining storage quota does not permit for a file upload of this size.",
"description": "Folder owner's remaining storage quota does not permit for a file upload of this size.",
"value": {
"errors": [
{
"code": "ERR_SYSTEM_NO_STORAGE_AVAILABLE",
"message": "Folder owner's remaining storage quota does not permit for a file upload of this size."
}
]
}
}
}
}
}
},
"422": {
"description": "Unprocessable Content
Possible error codes: ERR_INPUT_INVALID_DATE, ERR_INPUT_INVALID_FORMAT, ERR_INPUT_MAX_VALUE, ERR_INPUT_MIN_VALUE, ERR_INVALID_PARAMETER, ERR_SYSTEM_NO_AVAILABLE_STORAGE_HOSTS",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
},
"examples": {
"ERR_INPUT_INVALID_DATE": {
"summary": "The input is not a valid date.",
"description": "The input is not a valid date.",
"value": {
"errors": [
{
"code": "ERR_INPUT_INVALID_DATE",
"message": "The input is not a valid date."
}
]
}
},
"ERR_INPUT_INVALID_FORMAT": {
"summary": "The input is invalid.",
"description": "The input is invalid.",
"value": {
"errors": [
{
"code": "ERR_INPUT_INVALID_FORMAT",
"message": "The input is invalid."
}
]
}
},
"ERR_INPUT_MAX_VALUE": {
"summary": "The specified input exceed the maximum allowed value.",
"description": "The specified input exceed the maximum allowed value.",
"value": {
"errors": [
{
"code": "ERR_INPUT_MAX_VALUE",
"message": "The specified input exceed the maximum allowed value."
}
]
}
},
"ERR_INPUT_MIN_VALUE": {
"summary": "The specified input below the minimum allowed value.",
"description": "The specified input below the minimum allowed value.",
"value": {
"errors": [
{
"code": "ERR_INPUT_MIN_VALUE",
"message": "The specified input below the minimum allowed value."
}
]
}
},
"ERR_INVALID_PARAMETER": {
"summary": "Invalid Parameter Exception",
"description": "Invalid Parameter Exception",
"value": {
"errors": [
{
"code": "ERR_INVALID_PARAMETER",
"message": "Invalid Parameter Exception"
}
]
}
},
"ERR_SYSTEM_NO_AVAILABLE_STORAGE_HOSTS": {
"summary": "No available storage hosts",
"description": "No available storage hosts",
"value": {
"errors": [
{
"code": "ERR_SYSTEM_NO_AVAILABLE_STORAGE_HOSTS",
"message": "No available storage hosts"
}
]
}
}
}
}
}
},
"490": {
"description": "Request blocked by WAF"
}
}
}
},
"/rest/mail/{id}/actions/withdrawFiles": {
"post": {
"summary": "Withdraw files from a sent message",
"description": "### Description:\n Using an email ID, withdraws the specified file attachments from a sent message.\n### Notes:\n - The message itself is not withdrawn. Only the links to its file attachments are deactivated, making the files inaccessible to the original recipients. The files remain in the system until they expire.\n - If a recipient forwarded the message before it was withdrawn, attachment links remain active for those recipients until the files expire.\n### Preconditions:\n Must be the sender of the message.\n### Response:\n Deactivates download links for the specified email attachments.\n",
"tags": [
"mail"
],
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"description": "The unique identifier (UUID) of the email.",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "query",
"name": "id:in",
"required": true,
"explode": true,
"style": "form",
"description": "A comma-separated list of attachment IDs to be withdrawn.",
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
{
"in": "query",
"name": "sharedMailboxId",
"required": false,
"description": "The unique identifier of the Shared Mailbox. If provided, the operation will be performed within the specified Shared Mailbox context.",
"schema": {
"type": "string"
}
}
],
"responses": {
"204": {
"description": "Attachments withdrawn successfully."
},
"401": {
"description": "Unauthorized
Possible error codes: ERR_AUTH_INVALID_CSRF, ERR_AUTH_UNAUTHORIZED",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
},
"examples": {
"ERR_AUTH_INVALID_CSRF": {
"summary": "Invalid CSRF Authentication",
"description": "Invalid CSRF Authentication",
"value": {
"errors": [
{
"code": "ERR_AUTH_INVALID_CSRF",
"message": "Invalid CSRF Authentication"
}
]
}
},
"ERR_AUTH_UNAUTHORIZED": {
"summary": "Unauthorized",
"description": "Unauthorized",
"value": {
"errors": [
{
"code": "ERR_AUTH_UNAUTHORIZED",
"message": "Unauthorized"
}
]
}
}
}
}
}
},
"403": {
"description": "Forbidden
Possible error codes: ERR_ACCESS_NOT_SENDER, ERR_ACCESS_USER, ERR_ENTITY_DELETED, ERR_ENTITY_IS_DELETED_ATTACHMENT",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
},
"examples": {
"ERR_ACCESS_NOT_SENDER": {
"summary": "Authenticated user is not the sender of the specified email",
"description": "Authenticated user is not the sender of the specified email",
"value": {
"errors": [
{
"code": "ERR_ACCESS_NOT_SENDER",
"message": "Authenticated user is not the sender of the specified email"
}
]
}
},
"ERR_ACCESS_USER": {
"summary": "Insufficient access permissions",
"description": "Insufficient access permissions",
"value": {
"errors": [
{
"code": "ERR_ACCESS_USER",
"message": "Insufficient access permissions"
}
]
}
},
"ERR_ENTITY_DELETED": {
"summary": "Entity is deleted",
"description": "Entity is deleted",
"value": {
"errors": [
{
"code": "ERR_ENTITY_DELETED",
"message": "Entity is deleted"
}
]
}
},
"ERR_ENTITY_IS_DELETED_ATTACHMENT": {
"summary": "Requested Attachment(s) is deleted",
"description": "Requested Attachment(s) is deleted",
"value": {
"errors": [
{
"code": "ERR_ENTITY_IS_DELETED_ATTACHMENT",
"message": "Requested Attachment(s) is deleted"
}
]
}
}
}
}
}
},
"422": {
"description": "Unprocessable Content
Possible error codes: ERR_INVALID_PARAMETER",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
},
"examples": {
"ERR_INVALID_PARAMETER": {
"summary": "Invalid Parameter Exception",
"description": "Invalid Parameter Exception",
"value": {
"errors": [
{
"code": "ERR_INVALID_PARAMETER",
"message": "Invalid Parameter Exception"
}
]
}
}
}
}
}
},
"490": {
"description": "Request blocked by WAF"
}
}
}
},
"/rest/mail/{id}/actions/copy": {
"post": {
"summary": "Save email attachments to a Kiteworks folder",
"description": "### Description:\n Saves one or more email attachments to a specified Kiteworks folder.\n### Preconditions:\n Must have the `file_copy` permission for the files being copied and `file_add` permission for the destination folder.\n### Response:\n Returns the saved files in the destination folder. If duplicate filenames exist, a number is appended to the saved file names to avoid conflicts.\n",
"tags": [
"mail"
],
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"description": "The unique identifier (UUID) of the email.",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "query",
"name": "id:in",
"required": true,
"explode": true,
"style": "form",
"schema": {
"type": "array",
"description": "",
"items": {
"type": "string"
}
}
},
{
"in": "query",
"name": "returnEntity",
"required": false,
"description": "If true, includes the entity in the response body.",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "with",
"required": false,
"description": "Specifies additional fields to include in the response.",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "mode",
"required": false,
"description": "Determines the detail level of the response body.",
"schema": {
"type": "string",
"enum": [
"compact",
"full_no_links",
"full_with_links",
"full"
]
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DestinationFolderIdRequest"
}
}
}
},
"responses": {
"201": {
"description": "Attachment files copied successfully.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/File"
}
}
}
},
"401": {
"description": "Unauthorized
Possible error codes: ERR_AUTH_INVALID_CSRF, ERR_AUTH_UNAUTHORIZED",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
},
"examples": {
"ERR_AUTH_INVALID_CSRF": {
"summary": "Invalid CSRF Authentication",
"description": "Invalid CSRF Authentication",
"value": {
"errors": [
{
"code": "ERR_AUTH_INVALID_CSRF",
"message": "Invalid CSRF Authentication"
}
]
}
},
"ERR_AUTH_UNAUTHORIZED": {
"summary": "Unauthorized",
"description": "Unauthorized",
"value": {
"errors": [
{
"code": "ERR_AUTH_UNAUTHORIZED",
"message": "Unauthorized"
}
]
}
}
}
}
}
},
"403": {
"description": "Forbidden
Possible error codes: ERR_ACCESS_NOT_SENDER, ERR_ACCESS_USER, ERR_ENTITY_DELETED, ERR_ENTITY_IS_BASE_DIR, ERR_ENTITY_IS_DELETED_ATTACHMENT, ERR_ENTITY_IS_MY_DIR, ERR_ENTITY_IS_SECURE_FOLDER, ERR_ENTITY_RESTRICTED_EXTENSION, ERR_ENTITY_RESTRICTED_TYPE",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
},
"examples": {
"ERR_ACCESS_NOT_SENDER": {
"summary": "Authenticated user is not the sender of the specified email",
"description": "Authenticated user is not the sender of the specified email",
"value": {
"errors": [
{
"code": "ERR_ACCESS_NOT_SENDER",
"message": "Authenticated user is not the sender of the specified email"
}
]
}
},
"ERR_ACCESS_USER": {
"summary": "Insufficient access permissions",
"description": "Insufficient access permissions",
"value": {
"errors": [
{
"code": "ERR_ACCESS_USER",
"message": "Insufficient access permissions"
}
]
}
},
"ERR_ENTITY_DELETED": {
"summary": "Entity is deleted",
"description": "Entity is deleted",
"value": {
"errors": [
{
"code": "ERR_ENTITY_DELETED",
"message": "Entity is deleted"
}
]
}
},
"ERR_ENTITY_IS_BASE_DIR": {
"summary": "Operation not permitted on Base Folder",
"description": "Operation not permitted on Base Folder",
"value": {
"errors": [
{
"code": "ERR_ENTITY_IS_BASE_DIR",
"message": "Operation not permitted on Base Folder"
}
]
}
},
"ERR_ENTITY_IS_DELETED_ATTACHMENT": {
"summary": "Requested Attachment(s) is deleted",
"description": "Requested Attachment(s) is deleted",
"value": {
"errors": [
{
"code": "ERR_ENTITY_IS_DELETED_ATTACHMENT",
"message": "Requested Attachment(s) is deleted"
}
]
}
},
"ERR_ENTITY_IS_MY_DIR": {
"summary": "Operation not permitted on Tray Folder",
"description": "Operation not permitted on Tray Folder",
"value": {
"errors": [
{
"code": "ERR_ENTITY_IS_MY_DIR",
"message": "Operation not permitted on Tray Folder"
}
]
}
},
"ERR_ENTITY_IS_SECURE_FOLDER": {
"summary": "Operation not permitted on restricted Folder.",
"description": "Operation not permitted on restricted Folder.",
"value": {
"errors": [
{
"code": "ERR_ENTITY_IS_SECURE_FOLDER",
"message": "Operation not permitted on restricted Folder."
}
]
}
},
"ERR_ENTITY_RESTRICTED_EXTENSION": {
"summary": "File extension is in exclusion extensions list",
"description": "File extension is in exclusion extensions list",
"value": {
"errors": [
{
"code": "ERR_ENTITY_RESTRICTED_EXTENSION",
"message": "File extension is in exclusion extensions list"
}
]
}
},
"ERR_ENTITY_RESTRICTED_TYPE": {
"summary": "The specified entity mime type is not allowed.",
"description": "The specified entity mime type is not allowed.",
"value": {
"errors": [
{
"code": "ERR_ENTITY_RESTRICTED_TYPE",
"message": "The specified entity mime type is not allowed."
}
]
}
}
}
}
}
},
"422": {
"description": "Unprocessable Content
Possible error codes: ERR_INVALID_PARAMETER",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
},
"examples": {
"ERR_INVALID_PARAMETER": {
"summary": "Invalid Parameter Exception",
"description": "Invalid Parameter Exception",
"value": {
"errors": [
{
"code": "ERR_INVALID_PARAMETER",
"message": "Invalid Parameter Exception"
}
]
}
}
}
}
}
},
"490": {
"description": "Request blocked by WAF"
}
}
}
},
"/rest/mail/{id}/actions/sendTrackingReport": {
"post": {
"summary": "Send tracked activity report for a sent message",
"description": "### Description:\n Generates and emails a tracked activity report for a sent message to the current user's Inbox.\n### Preconditions:\n Must be the sender of the message and have tracking access enabled.\n### Response:\n Sends the tracking report to the current user's Inbox.\n",
"tags": [
"mail"
],
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"description": "The unique identifier (UUID) of the email.",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "query",
"name": "returnEntity",
"required": false,
"description": "If true, includes the entity in the response body.",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "with",
"required": false,
"description": "Specifies additional fields to include in the response.",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "mode",
"required": false,
"description": "Determines the detail level of the response body.",
"schema": {
"type": "string",
"enum": [
"compact",
"full_no_links",
"full_with_links",
"full"
]
}
}
],
"responses": {
"201": {
"description": "Tracking report sent successfully."
},
"401": {
"description": "Unauthorized
Possible error codes: ERR_AUTH_INVALID_CSRF, ERR_AUTH_UNAUTHORIZED",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
},
"examples": {
"ERR_AUTH_INVALID_CSRF": {
"summary": "Invalid CSRF Authentication",
"description": "Invalid CSRF Authentication",
"value": {
"errors": [
{
"code": "ERR_AUTH_INVALID_CSRF",
"message": "Invalid CSRF Authentication"
}
]
}
},
"ERR_AUTH_UNAUTHORIZED": {
"summary": "Unauthorized",
"description": "Unauthorized",
"value": {
"errors": [
{
"code": "ERR_AUTH_UNAUTHORIZED",
"message": "Unauthorized"
}
]
}
}
}
}
}
},
"403": {
"description": "Forbidden
Possible error codes: ERR_ACCESS_NOT_SENDER, ERR_ACCESS_USER",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
},
"examples": {
"ERR_ACCESS_NOT_SENDER": {
"summary": "Authenticated user is not the sender of the specified email",
"description": "Authenticated user is not the sender of the specified email",
"value": {
"errors": [
{
"code": "ERR_ACCESS_NOT_SENDER",
"message": "Authenticated user is not the sender of the specified email"
}
]
}
},
"ERR_ACCESS_USER": {
"summary": "Insufficient access permissions",
"description": "Insufficient access permissions",
"value": {
"errors": [
{
"code": "ERR_ACCESS_USER",
"message": "Insufficient access permissions"
}
]
}
}
}
}
}
},
"490": {
"description": "Request blocked by WAF"
}
}
}
},
"/rest/mail/attachments": {
"get": {
"summary": "Get email attachments sent by the current user",
"description": "### Description:\n Using an email ID, gets a list of files attached to messages in the current user's Inbox or Drafts folder, including file metadata.\n### Preconditions:\n Messages must belong to the current user.\n### Response:\n Returns the list of email attachments with associated metadata.\n### Sorting:\n Sort string syntax `FIELD_NAME:ORDER`.\n\n ORDER can be `asc` or `desc`.\n### Sorting options:\n | FIELD_NAME | Description |\n |---------------|------------------------------------------|\n | id | The mail ID |\n | subject | The mail subject |\n | sent_date | The date the mail was sent |\n | modified_date | The date the mail was last modified |\n | type | The mail type: `sent`, `draft`, or `request` |\n | size | The file size |\n",
"tags": [
"mail"
],
"parameters": [
{
"in": "query",
"name": "limit",
"required": false,
"description": "Range limit.",
"schema": {
"type": "integer",
"minimum": 1
}
},
{
"in": "query",
"name": "offset",
"required": false,
"description": "Range offset.",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"in": "query",
"name": "bucket",
"required": false,
"description": "Filters attachments to those belonging to emails in the specified bucket.
`inbox` \u2013 Received emails.
`draft` \u2013 Unsent draft emails.
`outgoing` \u2013 Emails queued or in progress.
`sent` \u2013 Successfully sent emails.
`trash` \u2013 Deleted emails.",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "orderBy",
"required": false,
"description": "Sort order for the results. Default is `id:desc`.
Allowed values: `id:asc`, `id:desc`, `subject:asc`, `subject:desc`, `sent_date:asc`, `sent_date:desc`, `modified_date:asc`, `modified_date:desc`, `type:asc`, `type:desc`, `size:asc`, `size:desc`.",
"schema": {
"type": "string",
"enum": [
"id:asc",
"id:desc",
"subject:asc",
"subject:desc",
"sent_date:asc",
"sent_date:desc",
"modified_date:asc",
"modified_date:desc",
"type:asc",
"type:desc",
"size:asc",
"size:desc"
]
}
}
],
"responses": {
"200": {
"description": "Email attachments returned successfully.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MailAttachments"
}
}
}
},
"401": {
"description": "Unauthorized
Possible error codes: ERR_AUTH_INVALID_CSRF, ERR_AUTH_UNAUTHORIZED",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
},
"examples": {
"ERR_AUTH_INVALID_CSRF": {
"summary": "Invalid CSRF Authentication",
"description": "Invalid CSRF Authentication",
"value": {
"errors": [
{
"code": "ERR_AUTH_INVALID_CSRF",
"message": "Invalid CSRF Authentication"
}
]
}
},
"ERR_AUTH_UNAUTHORIZED": {
"summary": "Unauthorized",
"description": "Unauthorized",
"value": {
"errors": [
{
"code": "ERR_AUTH_UNAUTHORIZED",
"message": "Unauthorized"
}
]
}
}
}
}
}
},
"490": {
"description": "Request blocked by WAF"
}
}
},
"delete": {
"summary": "Withdraw multiple files from messages in Sent and Drafts folders",
"description": "### Description:\n Using attachment IDs, withdraws the specified attachments from messages in the current user's Sent and Drafts folders.\n### Notes:\n - The message itself is not withdrawn. Only the links to its file attachments are deactivated, making the files inaccessible to the original recipients. The files remain in the system until they expire.\n - If a recipient forwarded the message before it was withdrawn, attachment links remain active for those recipients until the files expire.\n### Preconditions:\n Must be the sender of the messages.\n### Response:\n Deactivates download links for the specified attachments across all matching Sent and Draft messages.\n",
"tags": [
"mail"
],
"parameters": [
{
"in": "query",
"name": "id:in",
"required": true,
"explode": true,
"style": "form",
"schema": {
"type": "array",
"description": "",
"items": {
"type": "string"
}
}
}
],
"responses": {
"204": {
"description": "Specified attachments withdrawn successfully."
},
"401": {
"description": "Unauthorized
Possible error codes: ERR_AUTH_INVALID_CSRF, ERR_AUTH_UNAUTHORIZED",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
},
"examples": {
"ERR_AUTH_INVALID_CSRF": {
"summary": "Invalid CSRF Authentication",
"description": "Invalid CSRF Authentication",
"value": {
"errors": [
{
"code": "ERR_AUTH_INVALID_CSRF",
"message": "Invalid CSRF Authentication"
}
]
}
},
"ERR_AUTH_UNAUTHORIZED": {
"summary": "Unauthorized",
"description": "Unauthorized",
"value": {
"errors": [
{
"code": "ERR_AUTH_UNAUTHORIZED",
"message": "Unauthorized"
}
]
}
}
}
}
}
},
"422": {
"description": "Unprocessable Content
Possible error codes: ERR_INVALID_PARAMETER",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
},
"examples": {
"ERR_INVALID_PARAMETER": {
"summary": "Invalid Parameter Exception",
"description": "Invalid Parameter Exception",
"value": {
"errors": [
{
"code": "ERR_INVALID_PARAMETER",
"message": "Invalid Parameter Exception"
}
]
}
}
}
}
}
},
"490": {
"description": "Request blocked by WAF"
}
}
}
},
"/rest/mail/actions/withdraw": {
"post": {
"summary": "Withdraw messages from Sent and Drafts folders",
"description": "### Description:\n Using email IDs, withdraws messages from the current user's Sent and Drafts folders.\n### Notes:\n - The messages themselves are not withdrawn. Only the links to their file attachments are deactivated, making the files inaccessible to the original recipients. The files remain in the system until they expire.\n - If a recipient forwarded a message before it was withdrawn, attachment links remain active for those recipients until the files expire.\n### Preconditions:\n Must be the sender of the messages.\n### Response:\n Deactivates download links for attachments in the specified messages.\n",
"tags": [
"mail"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MailWithdrawRequest"
}
}
}
},
"responses": {
"200": {
"description": "Email messages withdrawn successfully."
},
"207": {
"description": "Partially successful \u2014 some messages could not be withdrawn.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BulkOperationInteger"
}
}
}
},
"401": {
"description": "Unauthorized
Possible error codes: ERR_AUTH_INVALID_CSRF, ERR_AUTH_UNAUTHORIZED",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
},
"examples": {
"ERR_AUTH_INVALID_CSRF": {
"summary": "Invalid CSRF Authentication",
"description": "Invalid CSRF Authentication",
"value": {
"errors": [
{
"code": "ERR_AUTH_INVALID_CSRF",
"message": "Invalid CSRF Authentication"
}
]
}
},
"ERR_AUTH_UNAUTHORIZED": {
"summary": "Unauthorized",
"description": "Unauthorized",
"value": {
"errors": [
{
"code": "ERR_AUTH_UNAUTHORIZED",
"message": "Unauthorized"
}
]
}
}
}
}
}
},
"403": {
"description": "Forbidden
Possible error codes: ERR_ACCESS_USER, ERR_ENTITY_DELETED, ERR_ENTITY_EMAIL_IS_NOT_COMPLETED, ERR_ACCESS_NOT_SENDER, ERR_MAIL_BODY_UNSECURED, ERR_ENTITY_IS_EMAIL_CONTENT",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
},
"examples": {
"ERR_ACCESS_USER": {
"summary": "Insufficient access permissions",
"description": "Insufficient access permissions",
"value": {
"errors": [
{
"code": "ERR_ACCESS_USER",
"message": "Insufficient access permissions"
}
]
}
},
"ERR_ENTITY_DELETED": {
"summary": "Entity is deleted",
"description": "Entity is deleted",
"value": {
"errors": [
{
"code": "ERR_ENTITY_DELETED",
"message": "Entity is deleted"
}
]
}
},
"ERR_ENTITY_EMAIL_IS_NOT_COMPLETED": {
"summary": "Email is not completed",
"description": "Email is not completed",
"value": {
"errors": [
{
"code": "ERR_ENTITY_EMAIL_IS_NOT_COMPLETED",
"message": "Email is not completed"
}
]
}
},
"ERR_ACCESS_NOT_SENDER": {
"summary": "Authenticated user is not the sender of the specified email",
"description": "Authenticated user is not the sender of the specified email",
"value": {
"errors": [
{
"code": "ERR_ACCESS_NOT_SENDER",
"message": "Authenticated user is not the sender of the specified email"
}
]
}
},
"ERR_MAIL_BODY_UNSECURED": {
"summary": "Mail body is unsecured.",
"description": "Mail body is unsecured.",
"value": {
"errors": [
{
"code": "ERR_MAIL_BODY_UNSECURED",
"message": "Mail body is unsecured."
}
]
}
},
"ERR_ENTITY_IS_EMAIL_CONTENT": {
"summary": "Operation not permitted on email content",
"description": "Operation not permitted on email content",
"value": {
"errors": [
{
"code": "ERR_ENTITY_IS_EMAIL_CONTENT",
"message": "Operation not permitted on email content"
}
]
}
}
}
}
}
},
"490": {
"description": "Request blocked by WAF"
}
}
}
},
"/rest/mail/{id}/scanStatus": {
"get": {
"summary": "Get email message security scan status",
"description": "### Description:\n Gets the security scan results for a mail message. Depending on system scan policies, message content and attachments may be scanned for antivirus threats, data loss prevention (DLP) violations, and advanced threat protection (ATP).\n### Preconditions:\n Must be the sender or a recipient of the message.\n### Response:\n Returns the security scan status for the message and its attachments.\n",
"tags": [
"mail"
],
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"description": "The unique identifier (UUID) of the email.",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "Message and attachments (if any) have passed all security scans successfully."
},
"401": {
"description": "Unauthorized
Possible error codes: ERR_AUTH_UNAUTHORIZED",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
},
"examples": {
"ERR_AUTH_UNAUTHORIZED": {
"summary": "Unauthorized",
"description": "Unauthorized",
"value": {
"errors": [
{
"code": "ERR_AUTH_UNAUTHORIZED",
"message": "Unauthorized"
}
]
}
}
}
}
}
},
"403": {
"description": "Forbidden
Possible error codes: ERR_ACCESS_USER, ERR_ENTITY_EMAIL_IS_DRAFT, ERR_ENTITY_EMAIL_SCANNING, ERR_ENTITY_EMAIL_SCANNING_DISALLOWED",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
},
"examples": {
"ERR_ACCESS_USER": {
"summary": "Insufficient access permissions",
"description": "Insufficient access permissions",
"value": {
"errors": [
{
"code": "ERR_ACCESS_USER",
"message": "Insufficient access permissions"
}
]
}
},
"ERR_ENTITY_EMAIL_IS_DRAFT": {
"summary": "The action cannot be performed on draft.",
"description": "The action cannot be performed on draft.",
"value": {
"errors": [
{
"code": "ERR_ENTITY_EMAIL_IS_DRAFT",
"message": "The action cannot be performed on draft."
}
]
}
},
"ERR_ENTITY_EMAIL_SCANNING": {
"summary": "One or more files, or the email, are undergoing security and privacy scans. Please try again later.",
"description": "One or more files, or the email, are undergoing security and privacy scans. Please try again later.",
"value": {
"errors": [
{
"code": "ERR_ENTITY_EMAIL_SCANNING",
"message": "One or more files, or the email, are undergoing security and privacy scans. Please try again later."
}
]
}
},
"ERR_ENTITY_EMAIL_SCANNING_DISALLOWED": {
"summary": "One or more files, or the email, are blocked by system policy.",
"description": "One or more files, or the email, are blocked by system policy.",
"value": {
"errors": [
{
"code": "ERR_ENTITY_EMAIL_SCANNING_DISALLOWED",
"message": "One or more files, or the email, are blocked by system policy."
}
]
}
}
}
}
}
},
"490": {
"description": "Request blocked by WAF"
}
}
}
},
"/rest/mail/{id}/trackings/me": {
"delete": {
"summary": "Remove message tracking access",
"description": "### Description:\n Removes the current user's access to tracking activity on a specified message.\n### Preconditions:\n Must be a recipient of the email and have tracking access.\n### Response:\n Revokes the current user's tracking access for the specified message.\n",
"tags": [
"mail"
],
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"description": "The unique identifier (UUID) of the email.",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "Email tracking access removed successfully."
},
"401": {
"description": "Unauthorized
Possible error codes: ERR_AUTH_INVALID_CSRF, ERR_AUTH_UNAUTHORIZED",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
},
"examples": {
"ERR_AUTH_INVALID_CSRF": {
"summary": "Invalid CSRF Authentication",
"description": "Invalid CSRF Authentication",
"value": {
"errors": [
{
"code": "ERR_AUTH_INVALID_CSRF",
"message": "Invalid CSRF Authentication"
}
]
}
},
"ERR_AUTH_UNAUTHORIZED": {
"summary": "Unauthorized",
"description": "Unauthorized",
"value": {
"errors": [
{
"code": "ERR_AUTH_UNAUTHORIZED",
"message": "Unauthorized"
}
]
}
}
}
}
}
},
"403": {
"description": "Forbidden
Possible error codes: ERR_ACCESS_USER, ERR_ENTITY_DELETED",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
},
"examples": {
"ERR_ACCESS_USER": {
"summary": "Insufficient access permissions",
"description": "Insufficient access permissions",
"value": {
"errors": [
{
"code": "ERR_ACCESS_USER",
"message": "Insufficient access permissions"
}
]
}
},
"ERR_ENTITY_DELETED": {
"summary": "Entity is deleted",
"description": "Entity is deleted",
"value": {
"errors": [
{
"code": "ERR_ENTITY_DELETED",
"message": "Entity is deleted"
}
]
}
}
}
}
}
},
"490": {
"description": "Request blocked by WAF"
}
}
}
},
"/rest/mail/{id}/settings": {
"put": {
"summary": "Update message tracking access",
"description": "### Description:\n Updates the tracking access settings for a sent message, adding or removing tracking permissions for specified users.\n### Preconditions:\n Must be the sender of the message and have tracking access enabled.\n### Response:\n Returns a confirmation that tracking access has been updated for the specified users.\n",
"tags": [
"mail"
],
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"description": "The unique identifier (UUID) of the email.",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SendMailSettingPutRequest"
}
}
}
},
"responses": {
"200": {
"description": "Mail tracking settings updated successfully."
},
"401": {
"description": "Unauthorized
Possible error codes: ERR_AUTH_UNAUTHORIZED",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
},
"examples": {
"ERR_AUTH_UNAUTHORIZED": {
"summary": "Unauthorized",
"description": "Unauthorized",
"value": {
"errors": [
{
"code": "ERR_AUTH_UNAUTHORIZED",
"message": "Unauthorized"
}
]
}
}
}
}
}
},
"403": {
"description": "Forbidden
Possible error codes: ERR_ACCESS_USER, ERR_NOT_INTERNAL_DOMAIN, ERR_INSUFFICIENT_TRACKING_PERMISSIONS",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
},
"examples": {
"ERR_ACCESS_USER": {
"summary": "Insufficient access permissions",
"description": "Insufficient access permissions",
"value": {
"errors": [
{
"code": "ERR_ACCESS_USER",
"message": "Insufficient access permissions"
}
]
}
},
"ERR_NOT_INTERNAL_DOMAIN": {
"summary": "The email is not internal domain",
"description": "The email is not internal domain",
"value": {
"errors": [
{
"code": "ERR_NOT_INTERNAL_DOMAIN",
"message": "The email is not internal domain"
}
]
}
},
"ERR_INSUFFICIENT_TRACKING_PERMISSIONS": {
"summary": "This profile is not allowed to give tracking access due to insufficient permissions",
"description": "This profile is not allowed to give tracking access due to insufficient permissions",
"value": {
"errors": [
{
"code": "ERR_INSUFFICIENT_TRACKING_PERMISSIONS",
"message": "This profile is not allowed to give tracking access due to insufficient permissions"
}
]
}
}
}
}
}
},
"490": {
"description": "Request blocked by WAF"
}
}
}
},
"/rest/users/me/recent": {
"post": {
"summary": "Add objects to user's recent items",
"description": "### Description:\n Records one or more files or folders as recently accessed for the current user.\n### Precondition:\n User must be authenticated.\n### Response:\n The provided objects are added to the user's recent items list.\n",
"tags": [
"users"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RecentObjectsPostRequest"
}
}
}
},
"responses": {
"201": {
"description": "All recent items were successfully recorded."
},
"207": {
"description": "Some recent items were recorded successfully while others failed."
},
"400": {
"description": "Bad Request
Possible error codes: ERR_REQUEST_INVALID_JSON",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
},
"examples": {
"ERR_REQUEST_INVALID_JSON": {
"summary": "Invalid json provided",
"description": "Invalid json provided",
"value": {
"errors": [
{
"code": "ERR_REQUEST_INVALID_JSON",
"message": "Invalid json provided"
}
]
}
}
}
}
}
},
"401": {
"description": "Unauthorized
Possible error codes: ERR_AUTH_INVALID_CSRF, ERR_AUTH_UNAUTHORIZED",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
},
"examples": {
"ERR_AUTH_INVALID_CSRF": {
"summary": "Invalid CSRF Authentication",
"description": "Invalid CSRF Authentication",
"value": {
"errors": [
{
"code": "ERR_AUTH_INVALID_CSRF",
"message": "Invalid CSRF Authentication"
}
]
}
},
"ERR_AUTH_UNAUTHORIZED": {
"summary": "Unauthorized",
"description": "Unauthorized",
"value": {
"errors": [
{
"code": "ERR_AUTH_UNAUTHORIZED",
"message": "Unauthorized"
}
]
}
}
}
}
}
},
"422": {
"description": "Unprocessable Content
Possible error codes: ERR_INVALID_PARAMETER",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
},
"examples": {
"ERR_INVALID_PARAMETER": {
"summary": "Invalid Parameter Exception",
"description": "Invalid Parameter Exception",
"value": {
"errors": [
{
"code": "ERR_INVALID_PARAMETER",
"message": "Invalid Parameter Exception"
}
]
}
}
}
}
}
},
"490": {
"description": "Request blocked by WAF"
}
}
},
"get": {
"summary": "Return user's recent items",
"description": "### Description:\n Retrieves the current user's recently accessed files and folders.\n### Precondition:\n The user profile must have \"Collaboration Allowed\" enabled.\n### Response:\n Returns the list of the user's recently accessed items.\n",
"tags": [
"users"
],
"parameters": [
{
"in": "query",
"name": "returnEntity",
"required": false,
"description": "If true, includes the entity in the response body.",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "with",
"required": false,
"description": "Specifies additional fields to include in the response.",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "mode",
"required": false,
"description": "Determines the detail level of the response body.",
"schema": {
"type": "string",
"enum": [
"compact",
"full_no_links",
"full_with_links",
"full"
]
}
},
{
"in": "query",
"name": "type",
"required": false,
"explode": true,
"style": "form",
"description": "Filter recent items by object type. Accepts a list of type values.
`d` \u2013 Directories (folders) only.
`f` \u2013 Files only.
If omitted, both files and folders are returned.",
"schema": {
"type": "array",
"enum": [
"d",
"f"
],
"items": {
"type": "string"
}
}
}
],
"responses": {
"200": {
"description": "Request successfully processed and recent items returned.",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Folder"
},
{
"$ref": "#/components/schemas/File"
}
],
"discriminator": {
"propertyName": "type"
}
}
}
}
}
},
"401": {
"description": "Unauthorized
Possible error codes: ERR_AUTH_INVALID_CSRF, ERR_AUTH_UNAUTHORIZED",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
},
"examples": {
"ERR_AUTH_INVALID_CSRF": {
"summary": "Invalid CSRF Authentication",
"description": "Invalid CSRF Authentication",
"value": {
"errors": [
{
"code": "ERR_AUTH_INVALID_CSRF",
"message": "Invalid CSRF Authentication"
}
]
}
},
"ERR_AUTH_UNAUTHORIZED": {
"summary": "Unauthorized",
"description": "Unauthorized",
"value": {
"errors": [
{
"code": "ERR_AUTH_UNAUTHORIZED",
"message": "Unauthorized"
}
]
}
}
}
}
}
},
"490": {
"description": "Request blocked by WAF"
}
}
}
},
"/rest/users/me/recent/{id}": {
"delete": {
"summary": "Delete a user's recent item",
"description": "### Description:\n Removes the specified object from the current user's recent items list.\n### Precondition:\n User must be authenticated.\n### Response:\n The item is removed from the user's recent items.\n",
"tags": [
"users"
],
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"description": "The unique identifier of the entity.",
"schema": {
"type": "integer"
}
}
],
"responses": {
"204": {
"description": "The recent item was successfully removed."
},
"401": {
"description": "Unauthorized
Possible error codes: ERR_AUTH_INVALID_CSRF, ERR_AUTH_UNAUTHORIZED",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
},
"examples": {
"ERR_AUTH_INVALID_CSRF": {
"summary": "Invalid CSRF Authentication",
"description": "Invalid CSRF Authentication",
"value": {
"errors": [
{
"code": "ERR_AUTH_INVALID_CSRF",
"message": "Invalid CSRF Authentication"
}
]
}
},
"ERR_AUTH_UNAUTHORIZED": {
"summary": "Unauthorized",
"description": "Unauthorized",
"value": {
"errors": [
{
"code": "ERR_AUTH_UNAUTHORIZED",
"message": "Unauthorized"
}
]
}
}
}
}
}
},
"490": {
"description": "Request blocked by WAF"
}
}
}
},
"/rest/users/me/pins": {
"post": {
"summary": "Pin items for the current user",
"description": "### Description:\n Pins the specified entities to the current user's pinned list.\n### Precondition:\n User must be authenticated.\n### Response:\n The specified items are pinned.\n",
"tags": [
"users"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UserMePinsPostRequest"
}
}
}
},
"responses": {
"204": {
"description": "The items were successfully pinned."
},
"400": {
"description": "Bad Request
Possible error codes: ERR_REQUEST_INVALID_JSON",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
},
"examples": {
"ERR_REQUEST_INVALID_JSON": {
"summary": "Invalid json provided",
"description": "Invalid json provided",
"value": {
"errors": [
{
"code": "ERR_REQUEST_INVALID_JSON",
"message": "Invalid json provided"
}
]
}
}
}
}
}
},
"401": {
"description": "Unauthorized
Possible error codes: ERR_AUTH_INVALID_CSRF, ERR_AUTH_UNAUTHORIZED",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
},
"examples": {
"ERR_AUTH_INVALID_CSRF": {
"summary": "Invalid CSRF Authentication",
"description": "Invalid CSRF Authentication",
"value": {
"errors": [
{
"code": "ERR_AUTH_INVALID_CSRF",
"message": "Invalid CSRF Authentication"
}
]
}
},
"ERR_AUTH_UNAUTHORIZED": {
"summary": "Unauthorized",
"description": "Unauthorized",
"value": {
"errors": [
{
"code": "ERR_AUTH_UNAUTHORIZED",
"message": "Unauthorized"
}
]
}
}
}
}
}
},
"403": {
"description": "Forbidden
Possible error codes: ERR_ACCESS_USER",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
},
"examples": {
"ERR_ACCESS_USER": {
"summary": "Insufficient access permissions",
"description": "Insufficient access permissions",
"value": {
"errors": [
{
"code": "ERR_ACCESS_USER",
"message": "Insufficient access permissions"
}
]
}
}
}
}
}
},
"422": {
"description": "Unprocessable Content
Possible error codes: ERR_INVALID_PARAMETER",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
},
"examples": {
"ERR_INVALID_PARAMETER": {
"summary": "Invalid Parameter Exception",
"description": "Invalid Parameter Exception",
"value": {
"errors": [
{
"code": "ERR_INVALID_PARAMETER",
"message": "Invalid Parameter Exception"
}
]
}
}
}
}
}
},
"490": {
"description": "Request blocked by WAF"
}
}
},
"delete": {
"summary": "Unpin items for the current user",
"description": "### Description:\n Removes the specified entities from the current user's pinned list.\n### Precondition:\n User must be authenticated.\n### Response:\n The specified items are unpinned.\n",
"tags": [
"users"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UserMePinsPostRequest"
}
}
}
},
"responses": {
"204": {
"description": "The items were successfully unpinned."
},
"400": {
"description": "Bad Request
Possible error codes: ERR_REQUEST_INVALID_JSON",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
},
"examples": {
"ERR_REQUEST_INVALID_JSON": {
"summary": "Invalid json provided",
"description": "Invalid json provided",
"value": {
"errors": [
{
"code": "ERR_REQUEST_INVALID_JSON",
"message": "Invalid json provided"
}
]
}
}
}
}
}
},
"401": {
"description": "Unauthorized
Possible error codes: ERR_AUTH_INVALID_CSRF, ERR_AUTH_UNAUTHORIZED",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
},
"examples": {
"ERR_AUTH_INVALID_CSRF": {
"summary": "Invalid CSRF Authentication",
"description": "Invalid CSRF Authentication",
"value": {
"errors": [
{
"code": "ERR_AUTH_INVALID_CSRF",
"message": "Invalid CSRF Authentication"
}
]
}
},
"ERR_AUTH_UNAUTHORIZED": {
"summary": "Unauthorized",
"description": "Unauthorized",
"value": {
"errors": [
{
"code": "ERR_AUTH_UNAUTHORIZED",
"message": "Unauthorized"
}
]
}
}
}
}
}
},
"422": {
"description": "Unprocessable Content
Possible error codes: ERR_INVALID_PARAMETER",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
},
"examples": {
"ERR_INVALID_PARAMETER": {
"summary": "Invalid Parameter Exception",
"description": "Invalid Parameter Exception",
"value": {
"errors": [
{
"code": "ERR_INVALID_PARAMETER",
"message": "Invalid Parameter Exception"
}
]
}
}
}
}
}
},
"490": {
"description": "Request blocked by WAF"
}
}
}
},
"/rest/users/actions/getDistributionList": {
"get": {
"summary": "Check emails for LDAP distribution list status",
"description": "### Description:\n Checks whether the provided email addresses correspond to LDAP distribution lists rather than individual users.\n### Precondition:\n User must be authenticated.\n### Response:\n Returns each email address along with a flag indicating whether it is an LDAP distribution list.\n",
"tags": [
"users"
],
"parameters": [
{
"in": "query",
"name": "email:in",
"required": true,
"explode": true,
"style": "form",
"description": "Comma-separated list of email addresses to check for LDAP distribution list status.",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "email"
}
}
}
],
"responses": {
"200": {
"description": "The distribution list status for each email has been successfully returned.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UserDistributionLists"
}
}
}
},
"401": {
"description": "Unauthorized
Possible error codes: ERR_AUTH_INVALID_CSRF, ERR_AUTH_UNAUTHORIZED",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
},
"examples": {
"ERR_AUTH_INVALID_CSRF": {
"summary": "Invalid CSRF Authentication",
"description": "Invalid CSRF Authentication",
"value": {
"errors": [
{
"code": "ERR_AUTH_INVALID_CSRF",
"message": "Invalid CSRF Authentication"
}
]
}
},
"ERR_AUTH_UNAUTHORIZED": {
"summary": "Unauthorized",
"description": "Unauthorized",
"value": {
"errors": [
{
"code": "ERR_AUTH_UNAUTHORIZED",
"message": "Unauthorized"
}
]
}
}
}
}
}
},
"403": {
"description": "Forbidden
Possible error codes: ERR_ACCESS_DENIED, ERR_ACCESS_USER",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
},
"examples": {
"ERR_ACCESS_DENIED": {
"summary": "Your access is denied.",
"description": "Your access is denied.",
"value": {
"errors": [
{
"code": "ERR_ACCESS_DENIED",
"message": "Your access is denied.",
"redirectUrl": "/login?code=3317"
}
]
}
},
"ERR_ACCESS_USER": {
"summary": "Insufficient access permissions",
"description": "Insufficient access permissions",
"value": {
"errors": [
{
"code": "ERR_ACCESS_USER",
"message": "Insufficient access permissions"
}
]
}
}
}
}
}
},
"490": {
"description": "Request blocked by WAF"
}
}
}
},
"/rest/users/me/concurrent/challenge": {
"get": {
"summary": "Get concurrent session challenge",
"description": "### Description:\n Returns information about the existing concurrent session that must be resolved before the current login can proceed.\n### Precondition:\n User must be in the `concurrent` login state.\n### Response:\n Returns the concurrent session details required to complete the challenge.\n",
"tags": [
"users"
],
"responses": {
"200": {
"description": "The concurrent session challenge details have been successfully returned.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UserMeConcurrentChallenge"
}
}
}
},
"401": {
"description": "Unauthorized
Possible error codes: ERR_AUTH_INVALID_CSRF, ERR_AUTH_UNAUTHORIZED",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
},
"examples": {
"ERR_AUTH_INVALID_CSRF": {
"summary": "Invalid CSRF Authentication",
"description": "Invalid CSRF Authentication",
"value": {
"errors": [
{
"code": "ERR_AUTH_INVALID_CSRF",
"message": "Invalid CSRF Authentication"
}
]
}
},
"ERR_AUTH_UNAUTHORIZED": {
"summary": "Unauthorized",
"description": "Unauthorized",
"value": {
"errors": [
{
"code": "ERR_AUTH_UNAUTHORIZED",
"message": "Unauthorized"
}
]
}
}
}
}
}
},
"403": {
"description": "Forbidden
Possible error codes: ERR_AUTH_WRONG_LOGIN_STATE, ERR_CONCURRENT_NOT_FOUND",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
},
"examples": {
"ERR_AUTH_WRONG_LOGIN_STATE": {
"summary": "Wrong login state",
"description": "Wrong login state",
"value": {
"errors": [
{
"code": "ERR_AUTH_WRONG_LOGIN_STATE",
"message": "Wrong login state"
}
]
}
},
"ERR_CONCURRENT_NOT_FOUND": {
"summary": "Concurrent session does not exist",
"description": "Concurrent session does not exist",
"value": {
"errors": [
{
"code": "ERR_CONCURRENT_NOT_FOUND",
"message": "Concurrent session does not exist"
}
]
}
}
}
}
}
},
"490": {
"description": "Request blocked by WAF"
}
}
}
},
"/rest/users/me/concurrent/auth": {
"post": {
"summary": "Resolve a concurrent session challenge",
"description": "### Description:\n Resolves a concurrent login challenge by either terminating the existing session or cancelling the current login attempt.\n### Precondition:\n User must be in the `concurrent` login state.\n### Response:\n Returns the login result after the concurrent session challenge is resolved.\n",
"tags": [
"users"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UserMeConcurrentAuthPostRequest"
}
}
}
},
"responses": {
"200": {
"description": "The concurrent session challenge was successfully resolved."
},
"401": {
"description": "Unauthorized
Possible error codes: ERR_AUTH_INVALID_CSRF, ERR_AUTH_UNAUTHORIZED",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
},
"examples": {
"ERR_AUTH_INVALID_CSRF": {
"summary": "Invalid CSRF Authentication",
"description": "Invalid CSRF Authentication",
"value": {
"errors": [
{
"code": "ERR_AUTH_INVALID_CSRF",
"message": "Invalid CSRF Authentication"
}
]
}
},
"ERR_AUTH_UNAUTHORIZED": {
"summary": "Unauthorized",
"description": "Unauthorized",
"value": {
"errors": [
{
"code": "ERR_AUTH_UNAUTHORIZED",
"message": "Unauthorized"
}
]
}
}
}
}
}
},
"403": {
"description": "Forbidden
Possible error codes: ERR_AUTH_WRONG_LOGIN_STATE",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
},
"examples": {
"ERR_AUTH_WRONG_LOGIN_STATE": {
"summary": "Wrong login state",
"description": "Wrong login state",
"value": {
"errors": [
{
"code": "ERR_AUTH_WRONG_LOGIN_STATE",
"message": "Wrong login state"
}
]
}
}
}
}
}
},
"490": {
"description": "Request blocked by WAF"
}
}
}
},
"/rest/mail/actions/requestFile": {
"post": {
"summary": "Request files to inbox",
"description": "### Description:\n Sends a request files to inbox message.\n### Precondition:\n Must be assigned a user profile with the ability to request files to inbox.\n### Response:\n Sends the message requesting files to your inbox.\n",
"tags": [
"requestFile"
],
"parameters": [
{
"in": "query",
"name": "returnEntity",
"required": false,
"description": "If true, includes the entity in the response body.",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "with",
"required": false,
"description": "Specifies additional fields to include in the response.",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "mode",
"required": false,
"description": "Determines the detail level of the response body.",
"schema": {
"type": "string",
"enum": [
"compact",
"full_no_links",
"full_with_links",
"full"
]
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RequestFileToInboxPostRequest"
}
}
}
},
"responses": {
"201": {
"description": "Request File to Inbox request has been successfully created."
},
"400": {
"description": "Bad Request
Possible error codes: ERR_REQUEST_INVALID_JSON",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
},
"examples": {
"ERR_REQUEST_INVALID_JSON": {
"summary": "Invalid json provided",
"description": "Invalid json provided",
"value": {
"errors": [
{
"code": "ERR_REQUEST_INVALID_JSON",
"message": "Invalid json provided"
}
]
}
}
}
}
}
},
"401": {
"description": "Unauthorized
Possible error codes: ERR_AUTH_INVALID_CSRF, ERR_AUTH_UNAUTHORIZED",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
},
"examples": {
"ERR_AUTH_INVALID_CSRF": {
"summary": "Invalid CSRF Authentication",
"description": "Invalid CSRF Authentication",
"value": {
"errors": [
{
"code": "ERR_AUTH_INVALID_CSRF",
"message": "Invalid CSRF Authentication"
}
]
}
},
"ERR_AUTH_UNAUTHORIZED": {
"summary": "Unauthorized",
"description": "Unauthorized",
"value": {
"errors": [
{
"code": "ERR_AUTH_UNAUTHORIZED",
"message": "Unauthorized"
}
]
}
}
}
}
}
},
"403": {
"description": "Forbidden
Possible error codes: ERR_INPUT_EMAIL_IS_DISTRIBUTION_LIST, ERR_LICENSE_MAX_USERS_COUNT_REACHED, ERR_SYSTEM_REQUEST_FILE_DISABLED, ERR_USER_HAS_NO_USER_TYPE, ERR_PROFILE_SEND_FILE_EXTERNAL_DISABLED, ERR_USER_TYPE_NO_ACCESS",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
},
"examples": {
"ERR_INPUT_EMAIL_IS_DISTRIBUTION_LIST": {
"summary": "Distribution list user is not allowed to register",
"description": "Distribution list user is not allowed to register",
"value": {
"errors": [
{
"code": "ERR_INPUT_EMAIL_IS_DISTRIBUTION_LIST",
"message": "Distribution list user is not allowed to register"
}
]
}
},
"ERR_LICENSE_MAX_USERS_COUNT_REACHED": {
"summary": "License count has been reached",
"description": "License count has been reached",
"value": {
"errors": [
{
"code": "ERR_LICENSE_MAX_USERS_COUNT_REACHED",
"message": "License count has been reached"
}
]
}
},
"ERR_SYSTEM_REQUEST_FILE_DISABLED": {
"summary": "Request file feature is not enabled on this system.",
"description": "Request file feature is not enabled on this system.",
"value": {
"errors": [
{
"code": "ERR_SYSTEM_REQUEST_FILE_DISABLED",
"message": "Request file feature is not enabled on this system."
}
]
}
},
"ERR_USER_HAS_NO_USER_TYPE": {
"summary": "User has no profile",
"description": "User has no profile",
"value": {
"errors": [
{
"code": "ERR_USER_HAS_NO_USER_TYPE",
"message": "User has no profile"
}
]
}
},
"ERR_PROFILE_SEND_FILE_EXTERNAL_DISABLED": {
"summary": "This profile is not allowed to send files to external users",
"description": "This profile is not allowed to send files to external users",
"value": {
"errors": [
{
"code": "ERR_PROFILE_SEND_FILE_EXTERNAL_DISABLED",
"message": "This profile is not allowed to send files to external users"
}
]
}
},
"ERR_USER_TYPE_NO_ACCESS": {
"summary": "Permission denied",
"description": "Permission denied",
"value": {
"errors": [
{
"code": "ERR_USER_TYPE_NO_ACCESS",
"message": "Permission denied"
}
]
}
}
}
}
}
},
"422": {
"description": "Unprocessable Content
Possible error codes: ERR_INPUT_HYPERLINK, ERR_INPUT_INVALID_DATE, ERR_INPUT_REQUIRED, ERR_INVALID_PARAMETER",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
},
"examples": {
"ERR_INPUT_HYPERLINK": {
"summary": "Not allowed hyperlink domain. Hyperlink domain should not different from anchored text domain.",
"description": "Not allowed hyperlink domain. Hyperlink domain should not different from anchored text domain.",
"value": {
"errors": [
{
"code": "ERR_INPUT_HYPERLINK",
"message": "Not allowed hyperlink domain. Hyperlink domain should not different from anchored text domain."
}
]
}
},
"ERR_INPUT_INVALID_DATE": {
"summary": "The input is not a valid date.",
"description": "The input is not a valid date.",
"value": {
"errors": [
{
"code": "ERR_INPUT_INVALID_DATE",
"message": "The input is not a valid date."
}
]
}
},
"ERR_INPUT_REQUIRED": {
"summary": "Field is required",
"description": "Field is required",
"value": {
"errors": [
{
"code": "ERR_INPUT_REQUIRED",
"message": "Field is required"
}
]
}
},
"ERR_INVALID_PARAMETER": {
"summary": "Invalid Parameter Exception",
"description": "Invalid Parameter Exception",
"value": {
"errors": [
{
"code": "ERR_INVALID_PARAMETER",
"message": "Invalid Parameter Exception"
}
]
}
}
}
}
}
},
"490": {
"description": "Request blocked by WAF"
}
}
}
},
"/rest/requestFile/{ref}/reply": {
"post": {
"summary": "Reply to Request File",
"description": "### Description:\n Processes a reply to a specific Request File.\n### Precondition:\n The user must be authenticated and have the proper access to reply to the specified request file.\n### Response:\n The reply to the request file is processed, and a successful response is returned with the status of the action.\n",
"tags": [
"requestFile"
],
"parameters": [
{
"in": "path",
"name": "ref",
"required": true,
"description": "The unique reference of the Request File upload link.",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RequestFileReplyPostRequest"
}
}
}
},
"responses": {
"201": {
"description": "The reply to the Request File has been successfully processed."
},
"400": {
"description": "Bad Request
Possible error codes: ERR_REQUEST_INVALID_JSON",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
},
"examples": {
"ERR_REQUEST_INVALID_JSON": {
"summary": "Invalid json provided",
"description": "Invalid json provided",
"value": {
"errors": [
{
"code": "ERR_REQUEST_INVALID_JSON",
"message": "Invalid json provided"
}
]
}
}
}
}
}
},
"401": {
"description": "Unauthorized
Possible error codes: ERR_AUTH_INVALID_CSRF, ERR_AUTH_UNAUTHORIZED",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
},
"examples": {
"ERR_AUTH_INVALID_CSRF": {
"summary": "Invalid CSRF Authentication",
"description": "Invalid CSRF Authentication",
"value": {
"errors": [
{
"code": "ERR_AUTH_INVALID_CSRF",
"message": "Invalid CSRF Authentication"
}
]
}
},
"ERR_AUTH_UNAUTHORIZED": {
"summary": "Unauthorized",
"description": "Unauthorized",
"value": {
"errors": [
{
"code": "ERR_AUTH_UNAUTHORIZED",
"message": "Unauthorized"
}
]
}
}
}
}
}
},
"403": {
"description": "Forbidden
Possible error codes: ERR_ACCESS_USER, ERR_ENTITY_REQUEST_FILE_NO_FILE_UPLOADED",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
},
"examples": {
"ERR_ACCESS_USER": {
"summary": "Insufficient access permissions",
"description": "Insufficient access permissions",
"value": {
"errors": [
{
"code": "ERR_ACCESS_USER",
"message": "Insufficient access permissions"
}
]
}
},
"ERR_ENTITY_REQUEST_FILE_NO_FILE_UPLOADED": {
"summary": "No file has been uploaded for the request file",
"description": "No file has been uploaded for the request file",
"value": {
"errors": [
{
"code": "ERR_ENTITY_REQUEST_FILE_NO_FILE_UPLOADED",
"message": "No file has been uploaded for the request file"
}
]
}
}
}
}
}
},
"422": {
"description": "Unprocessable Content
Possible error codes: ERR_INPUT_HYPERLINK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
},
"examples": {
"ERR_INPUT_HYPERLINK": {
"summary": "Not allowed hyperlink domain. Hyperlink domain should not different from anchored text domain.",
"description": "Not allowed hyperlink domain. Hyperlink domain should not different from anchored text domain.",
"value": {
"errors": [
{
"code": "ERR_INPUT_HYPERLINK",
"message": "Not allowed hyperlink domain. Hyperlink domain should not different from anchored text domain."
}
]
}
}
}
}
}
},
"490": {
"description": "Request blocked by WAF"
}
}
}
},
"/preview/file/{id}": {
"get": {
"summary": "Preview a file",
"description": "### Description:\n Returns the preview content for the specified file via the Repositories Gateway.\n### Precondition:\n User must have the `view` permission for the file.\n### Response:\n The preview content is returned.\n",
"tags": [
"files"
],
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"description": "The unique identifier of the entity.",
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "The preview content has been successfully returned."
},
"401": {
"description": "Unauthorized
Possible error codes: ERR_AUTH_UNAUTHORIZED",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
},
"examples": {
"ERR_AUTH_UNAUTHORIZED": {
"summary": "Unauthorized",
"description": "Unauthorized",
"value": {
"errors": [
{
"code": "ERR_AUTH_UNAUTHORIZED",
"message": "Unauthorized"
}
]
}
}
}
}
}
},
"403": {
"description": "Forbidden
Possible error codes: ERR_ENTITY_USER_HAS_INSUFFICIENT_PERMISSIONS",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
},
"examples": {
"ERR_ENTITY_USER_HAS_INSUFFICIENT_PERMISSIONS": {
"summary": "Target user has insufficient access permissions",
"description": "Target user has insufficient access permissions",
"value": {
"errors": [
{
"code": "ERR_ENTITY_USER_HAS_INSUFFICIENT_PERMISSIONS",
"message": "Target user has insufficient access permissions"
}
]
}
}
}
}
}
},
"490": {
"description": "Request blocked by WAF"
}
}
}
},
"/rest/folders/actions/move": {
"post": {
"summary": "Move multiple folders",
"description": "### Description:\n Moves multiple folders to a new destination folder.\n### Precondition:\n User must have `folder_move` permission for the folders being moved.\n User must have `folder_add` permission for the destination folder.\n### Response:\n The folders are moved to the destination folder.\n",
"tags": [
"folders"
],
"parameters": [
{
"in": "query",
"name": "returnEntity",
"required": false,
"description": "If true, includes the entity in the response body.",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "with",
"required": false,
"description": "Specifies additional fields to include in the response.",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "mode",
"required": false,
"description": "Determines the detail level of the response body.",
"schema": {
"type": "string",
"enum": [
"compact",
"full_no_links",
"full_with_links",
"full"
]
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MultipleFolderIdRequest"
}
}
}
},
"responses": {
"201": {
"description": "Folders successfully moved.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BulkOperationMoveFolders"
}
}
}
},
"207": {
"description": "Partially successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BulkOperationMoveFolders"
}
}
}
},
"403": {
"description": "Forbidden
Possible error codes: ERR_SYSTEM_FOLDER_QUOTA_EXCEEDED",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
},
"examples": {
"ERR_SYSTEM_FOLDER_QUOTA_EXCEEDED": {
"summary": "Folder's remaining storage quota does not permit for a file upload or operation of this size.",
"description": "Folder's remaining storage quota does not permit for a file upload or operation of this size.",
"value": {
"errors": [
{
"code": "ERR_SYSTEM_FOLDER_QUOTA_EXCEEDED",
"message": "Folder's remaining storage quota does not permit for a file upload or operation of this size."
}
]
}
}
}
}
}
},
"490": {
"description": "Request blocked by WAF"
}
}
}
},
"/rest/folders/{id}/quota": {
"get": {
"summary": "Return the folder quota",
"description": "### Description:\n Returns the quota information for a specific folder.\n### Precondition:\n User must have `file_add` permission for the folder.\n### Response:\n The folder quota is returned.\n",
"tags": [
"folders"
],
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"description": "The unique identifier (UUID) of the entity.",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "query",
"name": "fileId",
"required": false,
"description": "The unique identifier (UUID) of the file.",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "The folder quota has been successfully returned.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FolderQuota"
}
}
}
},
"401": {
"description": "Unauthorized
Possible error codes: ERR_ACCESS_USER, ERR_AUTH_INVALID_CSRF, ERR_AUTH_UNAUTHORIZED, ERR_ENTITY_NOT_FOUND",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
},
"examples": {
"ERR_ACCESS_USER": {
"summary": "Insufficient access permissions",
"description": "Insufficient access permissions",
"value": {
"errors": [
{
"code": "ERR_ACCESS_USER",
"message": "Insufficient access permissions"
}
]
}
},
"ERR_AUTH_INVALID_CSRF": {
"summary": "Invalid CSRF Authentication",
"description": "Invalid CSRF Authentication",
"value": {
"errors": [
{
"code": "ERR_AUTH_INVALID_CSRF",
"message": "Invalid CSRF Authentication"
}
]
}
},
"ERR_AUTH_UNAUTHORIZED": {
"summary": "Unauthorized",
"description": "Unauthorized",
"value": {
"errors": [
{
"code": "ERR_AUTH_UNAUTHORIZED",
"message": "Unauthorized"
}
]
}
},
"ERR_ENTITY_NOT_FOUND": {
"summary": "Entity does not exist",
"description": "Entity does not exist",
"value": {
"errors": [
{
"code": "ERR_ENTITY_NOT_FOUND",
"message": "Entity does not exist"
}
]
}
}
}
}
}
},
"403": {
"description": "Forbidden
Possible error codes: ERR_ENTITY_DELETED",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
},
"examples": {
"ERR_ENTITY_DELETED": {
"summary": "Entity is deleted",
"description": "Entity is deleted",
"value": {
"errors": [
{
"code": "ERR_ENTITY_DELETED",
"message": "Entity is deleted"
}
]
}
}
}
}
}
},
"490": {
"description": "Request blocked by WAF"
}
}
}
},
"/rest/folders/{id}/children": {
"get": {
"summary": "List folder children",
"description": "### Description:\n Returns the list of folder children, where folders are fetched first, followed by files.\n### Precondition:\n User must have `properties_view` permission for the folder.\n### Response:\n Returns a list of folders and files within the specified folder.\n### Sorting:\n Sort string syntax `FIELD_NAME:ORDER`.\n\n ORDER can be `asc` or `desc`.\n### Sorting options:\n | FIELD_NAME | Description |\n |------------|-------------|\n | name | The name of the folder or file |\n | created | The creation datetime of the folder or file |\n | modified | The last modified datetime of the folder or file |\n | size | The number of items in the folder (for folders) or the file size (for files) |\n",
"tags": [
"folders"
],
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"description": "The unique identifier (UUID) of the entity.",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "query",
"name": "deleted",
"required": false,
"description": "Filter by deletion status. If true, show only deleted items; if false, show non-deleted items; if not specified, show both deleted and non-deleted items.",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "orderBy",
"required": false,
"description": "Sort order for the results. Default is `name:asc`.
Allowed values: `name:asc`, `name:desc`, `created:asc`, `created:desc`, `modified:asc`, `modified:desc`, `size:asc`, `size:desc`.",
"schema": {
"type": "string",
"enum": [
"name:asc",
"name:desc",
"created:asc",
"created:desc",
"modified:asc",
"modified:desc",
"size:asc",
"size:desc"
]
}
},
{
"in": "query",
"name": "type",
"required": false,
"description": "Filter results by object type.
`f` \u2013 Files only.
`d` \u2013 Directories (folders) only.",
"schema": {
"type": "string",
"enum": [
"f",
"d"
]
}
},
{
"in": "query",
"name": "extensions",
"required": false,
"description": "A comma-delimited list of file extensions to include in the filter.",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "regex",
"required": false,
"description": "A regular expression pattern used to filter files by their names or other attributes.",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "name",
"required": false,
"description": "Filter by the name of the folder or file within the folder.",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "fileId",
"required": false,
"description": "Filter by a specific file ID.",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "limit",
"required": false,
"description": "Range limit.",
"schema": {
"type": "integer",
"minimum": 1
}
},
{
"in": "query",
"name": "offset",
"required": false,
"description": "Range offset.",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"in": "query",
"name": "with",
"required": false,
"description": "Specifies additional fields to include in the response.",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "mode",
"required": false,
"description": "Determines the detail level of the response body.",
"schema": {
"type": "string",
"enum": [
"compact",
"full_no_links",
"full_with_links",
"full"
]
}
}
],
"responses": {
"200": {
"description": "Returns the list of folder children.\n",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Folder"
},
{
"$ref": "#/components/schemas/File"
}
],
"discriminator": {
"propertyName": "type"
}
}
}
}
}
},
"400": {
"description": "Bad Request
Possible error codes: ERR_REQUEST_INVALID_JSON",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
},
"examples": {
"ERR_REQUEST_INVALID_JSON": {
"summary": "Invalid json provided",
"description": "Invalid json provided",
"value": {
"errors": [
{
"code": "ERR_REQUEST_INVALID_JSON",
"message": "Invalid json provided"
}
]
}
}
}
}
}
},
"401": {
"description": "Unauthorized
Possible error codes: ERR_ACCESS_USER, ERR_AUTH_INVALID_CSRF, ERR_AUTH_UNAUTHORIZED",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
},
"examples": {
"ERR_ACCESS_USER": {
"summary": "Insufficient access permissions",
"description": "Insufficient access permissions",
"value": {
"errors": [
{
"code": "ERR_ACCESS_USER",
"message": "Insufficient access permissions"
}
]
}
},
"ERR_AUTH_INVALID_CSRF": {
"summary": "Invalid CSRF Authentication",
"description": "Invalid CSRF Authentication",
"value": {
"errors": [
{
"code": "ERR_AUTH_INVALID_CSRF",
"message": "Invalid CSRF Authentication"
}
]
}
},
"ERR_AUTH_UNAUTHORIZED": {
"summary": "Unauthorized",
"description": "Unauthorized",
"value": {
"errors": [
{
"code": "ERR_AUTH_UNAUTHORIZED",
"message": "Unauthorized"
}
]
}
}
}
}
}
},
"422": {
"description": "Unprocessable Content
Possible error codes: ERR_INVALID_PARAMETER",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
},
"examples": {
"ERR_INVALID_PARAMETER": {
"summary": "Invalid Parameter Exception",
"description": "Invalid Parameter Exception",
"value": {
"errors": [
{
"code": "ERR_INVALID_PARAMETER",
"message": "Invalid Parameter Exception"
}
]
}
}
}
}
}
},
"490": {
"description": "Request blocked by WAF"
}
}
}
},
"/rest/folders/top": {
"get": {
"summary": "List top level folders",
"description": "### Description:\n Returns the list of top level folders.\n### Precondition:\n The user profile must have \"Collaboration Allowed\" enabled.\n### Response:\n Lists of top level folders are returned.\n### Sorting:\n Sort string syntax `FIELD_NAME:ORDER`.\n\n ORDER can be `asc` or `desc`.\n### Sorting options:\n | FIELD_NAME | Description |\n |------------|-------------|\n | name | The name of the folder |\n | created | The creation datetime of the folder |\n | modified | The last modified datetime of the folder |\n | size | The number of items in the folder |\n",
"tags": [
"folders"
],
"parameters": [
{
"in": "query",
"name": "deleted",
"required": false,
"description": "Filter by deletion status. If true, show only deleted items; if false, show non-deleted items; if not specified, show both deleted and non-deleted items.",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "orderBy",
"required": false,
"description": "Sort order for the results. Default is `name:asc`.
Allowed values: `name:asc`, `name:desc`, `created:asc`, `created:desc`, `modified:asc`, `modified:desc`, `size:asc`, `size:desc`.",
"schema": {
"type": "string",
"enum": [
"name:asc",
"name:desc",
"created:asc",
"created:desc",
"modified:asc",
"modified:desc",
"size:asc",
"size:desc"
]
}
},
{
"in": "query",
"name": "limit",
"required": false,
"description": "Range limit.",
"schema": {
"type": "integer",
"minimum": 1
}
},
{
"in": "query",
"name": "offset",
"required": false,
"description": "Range offset.",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"in": "query",
"name": "with",
"required": false,
"description": "Specifies additional fields to include in the response.",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "mode",
"required": false,
"description": "Determines the detail level of the response body.",
"schema": {
"type": "string",
"enum": [
"compact",
"full_no_links",
"full_with_links",
"full"
]
}
}
],
"responses": {
"200": {
"description": "The top level folders have been successfully returned.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Folders"
}
}
}
},
"400": {
"description": "Bad Request
Possible error codes: ERR_REQUEST_INVALID_JSON",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
},
"examples": {
"ERR_REQUEST_INVALID_JSON": {
"summary": "Invalid json provided",
"description": "Invalid json provided",
"value": {
"errors": [
{
"code": "ERR_REQUEST_INVALID_JSON",
"message": "Invalid json provided"
}
]
}
}
}
}
}
},
"401": {
"description": "Unauthorized
Possible error codes: ERR_ACCESS_USER, ERR_AUTH_INVALID_CSRF, ERR_AUTH_UNAUTHORIZED",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
},
"examples": {
"ERR_ACCESS_USER": {
"summary": "Insufficient access permissions",
"description": "Insufficient access permissions",
"value": {
"errors": [
{
"code": "ERR_ACCESS_USER",
"message": "Insufficient access permissions"
}
]
}
},
"ERR_AUTH_INVALID_CSRF": {
"summary": "Invalid CSRF Authentication",
"description": "Invalid CSRF Authentication",
"value": {
"errors": [
{
"code": "ERR_AUTH_INVALID_CSRF",
"message": "Invalid CSRF Authentication"
}
]
}
},
"ERR_AUTH_UNAUTHORIZED": {
"summary": "Unauthorized",
"description": "Unauthorized",
"value": {
"errors": [
{
"code": "ERR_AUTH_UNAUTHORIZED",
"message": "Unauthorized"
}
]
}
}
}
}
}
},
"422": {
"description": "Unprocessable Content
Possible error codes: ERR_INVALID_PARAMETER",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
},
"examples": {
"ERR_INVALID_PARAMETER": {
"summary": "Invalid Parameter Exception",
"description": "Invalid Parameter Exception",
"value": {
"errors": [
{
"code": "ERR_INVALID_PARAMETER",
"message": "Invalid Parameter Exception"
}
]
}
}
}
}
}
},
"490": {
"description": "Request blocked by WAF"
}
}
}
},
"/rest/folders/{id}": {
"put": {
"summary": "Update a folder",
"description": "### Description:\n Updates the properties of the specified folder.\n### Precondition:\n User must have `properties_edit` permission for the folder.\n### Response:\n The folder is updated.\n",
"tags": [
"folders"
],
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"description": "The unique identifier (UUID) of the entity.",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "query",
"name": "returnEntity",
"required": false,
"description": "If true, includes the entity in the response body.",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "with",
"required": false,
"description": "Specifies additional fields to include in the response.",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "mode",
"required": false,
"description": "Determines the detail level of the response body.",
"schema": {
"type": "string",
"enum": [
"compact",
"full_no_links",
"full_with_links",
"full"
]
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FolderUpdatePutRequest"
}
}
}
},
"responses": {
"200": {
"description": "The folder has been updated successfully.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Folder1"
}
}
}
},
"401": {
"description": "Unauthorized
Possible error codes: ERR_AUTH_INVALID_CSRF, ERR_AUTH_UNAUTHORIZED",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
},
"examples": {
"ERR_AUTH_INVALID_CSRF": {
"summary": "Invalid CSRF Authentication",
"description": "Invalid CSRF Authentication",
"value": {
"errors": [
{
"code": "ERR_AUTH_INVALID_CSRF",
"message": "Invalid CSRF Authentication"
}
]
}
},
"ERR_AUTH_UNAUTHORIZED": {
"summary": "Unauthorized",
"description": "Unauthorized",
"value": {
"errors": [
{
"code": "ERR_AUTH_UNAUTHORIZED",
"message": "Unauthorized"
}
]
}
}
}
}
}
},
"403": {
"description": "Forbidden
Possible error codes: ERR_ACCESS_DENIED, ERR_ACCESS_USER",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
},
"examples": {
"ERR_ACCESS_DENIED": {
"summary": "Your access is denied.",
"description": "Your access is denied.",
"value": {
"errors": [
{
"code": "ERR_ACCESS_DENIED",
"message": "Your access is denied.",
"redirectUrl": "/login?code=3317"
}
]
}
},
"ERR_ACCESS_USER": {
"summary": "Insufficient access permissions",
"description": "Insufficient access permissions",
"value": {
"errors": [
{
"code": "ERR_ACCESS_USER",
"message": "Insufficient access permissions"
}
]
}
}
}
}
}
},
"409": {
"description": "Conflict
Possible error codes: ERR_ENTITY_EXISTS",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
},
"examples": {
"ERR_ENTITY_EXISTS": {
"summary": "Entity exists",
"description": "Entity exists",
"value": {
"errors": [
{
"code": "ERR_ENTITY_EXISTS",
"message": "Entity exists"
}
]
}
}
}
}
}
},
"490": {
"description": "Request blocked by WAF"
}
}
},
"get": {
"summary": "Return the folder",
"description": "### Description:\n Returns the folder corresponding to the provided ID.\n### Precondition:\n User must have `properties_view` permission for the folder.\n### Response:\n The folder is returned.\n",
"tags": [
"folders"
],
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"description": "The unique identifier (UUID) of the entity.",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "query",
"name": "returnEntity",
"required": false,
"description": "If true, includes the entity in the response body.",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "with",
"required": false,
"description": "Specifies additional fields to include in the response.",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "mode",
"required": false,
"description": "Determines the detail level of the response body.",
"schema": {
"type": "string",
"enum": [
"compact",
"full_no_links",
"full_with_links",
"full"
]
}
}
],
"responses": {
"200": {
"description": "The folder has been successfully returned.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Folder1"
}
}
}
},
"400": {
"description": "Bad Request
Possible error codes: ERR_REQUEST_INVALID_FILTER",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
},
"examples": {
"ERR_REQUEST_INVALID_FILTER": {
"summary": "Filter validation failed",
"description": "Filter validation failed",
"value": {
"errors": [
{
"code": "ERR_REQUEST_INVALID_FILTER",
"message": "Filter validation failed"
}
]
}
}
}
}
}
},
"401": {
"description": "Unauthorized
Possible error codes: ERR_AUTH_INVALID_CSRF, ERR_AUTH_UNAUTHORIZED",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
},
"examples": {
"ERR_AUTH_INVALID_CSRF": {
"summary": "Invalid CSRF Authentication",
"description": "Invalid CSRF Authentication",
"value": {
"errors": [
{
"code": "ERR_AUTH_INVALID_CSRF",
"message": "Invalid CSRF Authentication"
}
]
}
},
"ERR_AUTH_UNAUTHORIZED": {
"summary": "Unauthorized",
"description": "Unauthorized",
"value": {
"errors": [
{
"code": "ERR_AUTH_UNAUTHORIZED",
"message": "Unauthorized"
}
]
}
}
}
}
}
},
"403": {
"description": "Forbidden
Possible error codes: ERR_ACCESS_USER, ERR_ACCESS_DENIED",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
},
"examples": {
"ERR_ACCESS_USER": {
"summary": "Insufficient access permissions",
"description": "Insufficient access permissions",
"value": {
"errors": [
{
"code": "ERR_ACCESS_USER",
"message": "Insufficient access permissions"
}
]
}
},
"ERR_ACCESS_DENIED": {
"summary": "Your access is denied.",
"description": "Your access is denied.",
"value": {
"errors": [
{
"code": "ERR_ACCESS_DENIED",
"message": "Your access is denied.",
"redirectUrl": "/login?code=3317"
}
]
}
}
}
}
}
},
"490": {
"description": "Request blocked by WAF"
}
}
},
"delete": {
"summary": "Delete a folder",
"description": "### Description:\n Deletes a specified folder.\n### Precondition:\n User must have `folder_delete` permission for the folder.\n### Response:\n The folder is deleted\n## Additional Information:\n The folder will be automatically deleted after a set number of days as configured by the administrator.\n",
"tags": [
"folders"
],
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"description": "The unique identifier (UUID) of the entity.",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"204": {
"description": "The folder has been successfully deleted."
},
"401": {
"description": "Unauthorized
Possible error codes: ERR_AUTH_INVALID_CSRF, ERR_AUTH_UNAUTHORIZED",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
},
"examples": {
"ERR_AUTH_INVALID_CSRF": {
"summary": "Invalid CSRF Authentication",
"description": "Invalid CSRF Authentication",
"value": {
"errors": [
{
"code": "ERR_AUTH_INVALID_CSRF",
"message": "Invalid CSRF Authentication"
}
]
}
},
"ERR_AUTH_UNAUTHORIZED": {
"summary": "Unauthorized",
"description": "Unauthorized",
"value": {
"errors": [
{
"code": "ERR_AUTH_UNAUTHORIZED",
"message": "Unauthorized"
}
]
}
}
}
}
}
},
"403": {
"description": "Forbidden
Possible error codes: ERR_SYSTEM_TENANT_SUSPENDED, ERR_ACCESS_DENIED, ERR_ENTITY_IS_SYNC_DIR, ERR_ENTITY_IS_MY_DIR, ERR_ENTITY_IS_BASE_DIR, ERR_ENTITY_IS_NOT_UPDATABLE, ERR_ENTITY_IS_SECURE_FOLDER, ERR_ENTITY_CONTAINS_LOCKED_FILES, ERR_ACCESS_USER, ERR_PROFILE_COLLABORATION_DISABLED, ERR_ENTITY_DELETED",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
},
"examples": {
"ERR_SYSTEM_TENANT_SUSPENDED": {
"summary": "Access to the service is restricted by the service provider. Contact your administrator for updates on restoring normal access.",
"description": "Access to the service is restricted by the service provider. Contact your administrator for updates on restoring normal access.",
"value": {
"errors": [
{
"code": "ERR_SYSTEM_TENANT_SUSPENDED",
"message": "Access to the service is restricted by the service provider. Contact your administrator for updates on restoring normal access."
}
]
}
},
"ERR_ACCESS_DENIED": {
"summary": "Your access is denied.",
"description": "Your access is denied.",
"value": {
"errors": [
{
"code": "ERR_ACCESS_DENIED",
"message": "Your access is denied.",
"redirectUrl": "/login?code=3317"
}
]
}
},
"ERR_ENTITY_IS_SYNC_DIR": {
"summary": "Operation not permitted on My Folder",
"description": "Operation not permitted on My Folder",
"value": {
"errors": [
{
"code": "ERR_ENTITY_IS_SYNC_DIR",
"message": "Operation not permitted on My Folder"
}
]
}
},
"ERR_ENTITY_IS_MY_DIR": {
"summary": "Operation not permitted on Tray Folder",
"description": "Operation not permitted on Tray Folder",
"value": {
"errors": [
{
"code": "ERR_ENTITY_IS_MY_DIR",
"message": "Operation not permitted on Tray Folder"
}
]
}
},
"ERR_ENTITY_IS_BASE_DIR": {
"summary": "Operation not permitted on Base Folder",
"description": "Operation not permitted on Base Folder",
"value": {
"errors": [
{
"code": "ERR_ENTITY_IS_BASE_DIR",
"message": "Operation not permitted on Base Folder"
}
]
}
},
"ERR_ENTITY_IS_NOT_UPDATABLE": {
"summary": "Can not update folder",
"description": "Can not update folder",
"value": {
"errors": [
{
"code": "ERR_ENTITY_IS_NOT_UPDATABLE",
"message": "Can not update folder"
}
]
}
},
"ERR_ENTITY_IS_SECURE_FOLDER": {
"summary": "Operation not permitted on restricted Folder.",
"description": "Operation not permitted on restricted Folder.",
"value": {
"errors": [
{
"code": "ERR_ENTITY_IS_SECURE_FOLDER",
"message": "Operation not permitted on restricted Folder."
}
]
}
},
"ERR_ENTITY_CONTAINS_LOCKED_FILES": {
"summary": "Folder contains locked files",
"description": "Folder contains locked files",
"value": {
"errors": [
{
"code": "ERR_ENTITY_CONTAINS_LOCKED_FILES",
"message": "Folder contains locked files"
}
]
}
},
"ERR_ACCESS_USER": {
"summary": "Insufficient access permissions",
"description": "Insufficient access permissions",
"value": {
"errors": [
{
"code": "ERR_ACCESS_USER",
"message": "Insufficient access permissions"
}
]
}
},
"ERR_PROFILE_COLLABORATION_DISABLED": {
"summary": "User's profile has no collaboration access",
"description": "User's profile has no collaboration access",
"value": {
"errors": [
{
"code": "ERR_PROFILE_COLLABORATION_DISABLED",
"message": "User's profile has no collaboration access"
}
]
}
},
"ERR_ENTITY_DELETED": {
"summary": "Entity is deleted",
"description": "Entity is deleted",
"value": {
"errors": [
{
"code": "ERR_ENTITY_DELETED",
"message": "Entity is deleted"
}
]
}
}
}
}
}
},
"490": {
"description": "Request blocked by WAF"
}
}
}
},
"/rest/folders/{id}/activities": {
"get": {
"summary": "Return folder activities",
"description": "### Description:\nReturn the activities of a specified folder.\n\n### Precondition:\nThe user must have the `user_view` permission for the folder.\n\n### Response:\nReturns the folder activities.\n",
"tags": [
"folders"
],
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"description": "The unique identifier (UUID) of the entity.",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "query",
"name": "noDayBack",
"required": false,
"description": "Number of days to look back when searching for activities.",
"schema": {
"type": "integer"
}
},
{
"in": "query",
"name": "startTime",
"required": false,
"description": "Start time of the search range, represented as a Unix timestamp.",
"schema": {
"type": "integer"
}
},
{
"in": "query",
"name": "endTime",
"required": false,
"description": "End time of the search range, represented as a Unix timestamp.",
"schema": {
"type": "integer"
}
},
{
"in": "query",
"name": "startDate",
"required": false,
"description": "Start date of the search range.",
"schema": {
"type": "string",
"format": "date"
}
},
{
"in": "query",
"name": "endDate",
"required": false,
"description": "End date of the search range.",
"schema": {
"type": "string",
"format": "date"
}
},
{
"in": "query",
"name": "filter",
"required": false,
"description": "Filter activities by ownership.
`all` \u2013 Show all activities in the folder.
`my` \u2013 Show only activities performed by the current user.",
"schema": {
"type": "string",
"enum": [
"all",
"my"
]
}
},
{
"in": "query",
"name": "search",
"required": false,
"description": "Search activities by email body, subject, sender, or recipients.",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "type",
"required": false,
"description": "Filter activities by type.
`all` \u2013 All activity types.
`content_changes` \u2013 File content uploads or replacements.
`file_changes` \u2013 File metadata changes (rename, move, delete, etc.).
`folder_changes` \u2013 Folder-level changes.
`kitepoint` \u2013 KitePoint reward activities.
`mail` \u2013 Email send/receive activities.
`tasks` \u2013 Task-related activities.
`comments` \u2013 Comment activities.
`folder_activities` \u2013 General folder activities.",
"schema": {
"type": "string",
"enum": [
"all",
"content_changes",
"file_changes",
"folder_changes",
"kitepoint",
"mail",
"tasks",
"comments",
"folder_activities"
]
}
},
{
"in": "query",
"name": "transactionId",
"required": false,
"description": "Filter activities by transaction ID.",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "orderBy",
"required": false,
"description": "Sort order for the results. Default is `created:desc`.
Allowed values: `id:asc`, `id:desc`, `created:asc`, `created:desc`, `event_name:asc`, `event_name:desc`, `name:asc`, `name:desc`.",
"schema": {
"type": "string",
"enum": [
"id:asc",
"id:desc",
"created:asc",
"created:desc",
"event_name:asc",
"event_name:desc",
"name:asc",
"name:desc"
]
}
},
{
"in": "query",
"name": "nested",
"required": false,
"description": "If set to `true`, includes activities from nested folders.",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "fileId",
"required": false,
"description": "Specifies a file ID within the folder to filter activities related to that file.",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "limit",
"required": false,
"description": "Range limit.",
"schema": {
"type": "integer",
"minimum": 1
}
},
{
"in": "query",
"name": "offset",
"required": false,
"description": "Range offset.",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"in": "query",
"name": "with",
"required": false,
"description": "Specifies additional fields to include in the response.",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "mode",
"required": false,
"description": "Determines the detail level of the response body.",
"schema": {
"type": "string",
"enum": [
"compact",
"full_no_links",
"full_with_links",
"full"
]
}
}
],
"responses": {
"200": {
"description": "Successfully return folder activities.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActivityList"
}
}
}
},
"401": {
"description": "Unauthorized
Possible error codes: ERR_ACCESS_USER, ERR_AUTH_INVALID_CSRF, ERR_AUTH_UNAUTHORIZED",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
},
"examples": {
"ERR_ACCESS_USER": {
"summary": "Insufficient access permissions",
"description": "Insufficient access permissions",
"value": {
"errors": [
{
"code": "ERR_ACCESS_USER",
"message": "Insufficient access permissions"
}
]
}
},
"ERR_AUTH_INVALID_CSRF": {
"summary": "Invalid CSRF Authentication",
"description": "Invalid CSRF Authentication",
"value": {
"errors": [
{
"code": "ERR_AUTH_INVALID_CSRF",
"message": "Invalid CSRF Authentication"
}
]
}
},
"ERR_AUTH_UNAUTHORIZED": {
"summary": "Unauthorized",
"description": "Unauthorized",
"value": {
"errors": [
{
"code": "ERR_AUTH_UNAUTHORIZED",
"message": "Unauthorized"
}
]
}
}
}
}
}
},
"422": {
"description": "Unprocessable Content
Possible error codes: ERR_INVALID_PARAMETER",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
},
"examples": {
"ERR_INVALID_PARAMETER": {
"summary": "Invalid Parameter Exception",
"description": "Invalid Parameter Exception",
"value": {
"errors": [
{
"code": "ERR_INVALID_PARAMETER",
"message": "Invalid Parameter Exception"
}
]
}
}
}
}
}
},
"490": {
"description": "Request blocked by WAF"
}
}
}
},
"/rest/folders/{id}/activities/actions/exportCSV": {
"get": {
"summary": "Export folder activities",
"description": "### Description:\nExports the activities of a folder in CSV format.\n\n### Precondition:\nThe user must have the `user_view` permission for the folder.\n\n### Response:\nThe folder activities are returned in CSV format.\n",
"tags": [
"folders"
],
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"description": "The unique identifier (UUID) of the entity.",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "query",
"name": "noDayBack",
"required": false,
"description": "Number of days to look back when searching for activities.",
"schema": {
"type": "integer"
}
},
{
"in": "query",
"name": "startTime",
"required": false,
"description": "Start time of the search range, represented as a Unix timestamp.",
"schema": {
"type": "integer"
}
},
{
"in": "query",
"name": "endTime",
"required": false,
"description": "End time of the search range, represented as a Unix timestamp.",
"schema": {
"type": "integer"
}
},
{
"in": "query",
"name": "startDate",
"required": false,
"description": "Start date of the search range.",
"schema": {
"type": "string",
"format": "date"
}
},
{
"in": "query",
"name": "endDate",
"required": false,
"description": "End date of the search range.",
"schema": {
"type": "string",
"format": "date"
}
},
{
"in": "query",
"name": "filter",
"required": false,
"description": "Filter activities by ownership.
`all` \u2013 Show all activities in the folder.
`my` \u2013 Show only activities performed by the current user.",
"schema": {
"type": "string",
"enum": [
"all",
"my"
]
}
},
{
"in": "query",
"name": "search",
"required": false,
"description": "Search activities by email body, subject, sender, or recipients.",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "type",
"required": false,
"description": "Filter activities by type.
`all` \u2013 All activity types.
`content_changes` \u2013 File content uploads or replacements.
`file_changes` \u2013 File metadata changes (rename, move, delete, etc.).
`folder_changes` \u2013 Folder-level changes.
`kitepoint` \u2013 KitePoint reward activities.
`mail` \u2013 Email send/receive activities.
`tasks` \u2013 Task-related activities.
`comments` \u2013 Comment activities.
`folder_activities` \u2013 General folder activities.",
"schema": {
"type": "string",
"enum": [
"all",
"content_changes",
"file_changes",
"folder_changes",
"kitepoint",
"mail",
"tasks",
"comments",
"folder_activities"
]
}
},
{
"in": "query",
"name": "transactionId",
"required": false,
"description": "Filter activities by transaction ID.",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "orderBy",
"required": false,
"description": "Sort order for the results. Default is `created:desc`.
Allowed values: `id:asc`, `id:desc`, `created:asc`, `created:desc`, `event_name:asc`, `event_name:desc`, `name:asc`, `name:desc`.",
"schema": {
"type": "string",
"enum": [
"id:asc",
"id:desc",
"created:asc",
"created:desc",
"event_name:asc",
"event_name:desc",
"name:asc",
"name:desc"
]
}
},
{
"in": "query",
"name": "nested",
"required": false,
"description": "If set to `true`, includes activities from nested folders.",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "fileId",
"required": false,
"description": "Specifies a file ID within the folder to filter activities related to that file.",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "limit",
"required": false,
"description": "Range limit.",
"schema": {
"type": "integer",
"minimum": 1
}
},
{
"in": "query",
"name": "offset",
"required": false,
"description": "Range offset.",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"in": "query",
"name": "with",
"required": false,
"description": "Specifies additional fields to include in the response.",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "mode",
"required": false,
"description": "Determines the detail level of the response body.",
"schema": {
"type": "string",
"enum": [
"compact",
"full_no_links",
"full_with_links",
"full"
]
}
}
],
"responses": {
"200": {
"description": "Successfully initiated the folder activities export.",
"content": {
"text/csv": {
"schema": {
"type": "string",
"format": "binary"
}
}
}
},
"401": {
"description": "Unauthorized
Possible error codes: ERR_ACCESS_USER, ERR_AUTH_INVALID_CSRF, ERR_AUTH_UNAUTHORIZED",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
},
"examples": {
"ERR_ACCESS_USER": {
"summary": "Insufficient access permissions",
"description": "Insufficient access permissions",
"value": {
"errors": [
{
"code": "ERR_ACCESS_USER",
"message": "Insufficient access permissions"
}
]
}
},
"ERR_AUTH_INVALID_CSRF": {
"summary": "Invalid CSRF Authentication",
"description": "Invalid CSRF Authentication",
"value": {
"errors": [
{
"code": "ERR_AUTH_INVALID_CSRF",
"message": "Invalid CSRF Authentication"
}
]
}
},
"ERR_AUTH_UNAUTHORIZED": {
"summary": "Unauthorized",
"description": "Unauthorized",
"value": {
"errors": [
{
"code": "ERR_AUTH_UNAUTHORIZED",
"message": "Unauthorized"
}
]
}
}
}
}
}
},
"422": {
"description": "Unprocessable Content
Possible error codes: ERR_INVALID_PARAMETER",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
},
"examples": {
"ERR_INVALID_PARAMETER": {
"summary": "Invalid Parameter Exception",
"description": "Invalid Parameter Exception",
"value": {
"errors": [
{
"code": "ERR_INVALID_PARAMETER",
"message": "Invalid Parameter Exception"
}
]
}
}
}
}
}
},
"490": {
"description": "Request blocked by WAF"
}
}
}
},
"/rest/folders/{id}/members/me": {
"delete": {
"summary": "Remove oneself as a folder member",
"description": "### Description:\nRemoves the current user from the specified folder.\n\n### Precondition:\nThe user must be a member of the folder.\n\n### Response:\nThe current user is removed from the folder.\n",
"tags": [
"folders"
],
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"description": "The unique identifier (UUID) of the entity.",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "query",
"name": "downgradeNested",
"required": false,
"description": "If set to `true`, the user's role will be removed from all nested folders.",
"schema": {
"type": "boolean"
}
}
],
"responses": {
"204": {
"description": "The user was successfully removed from the folder."
},
"401": {
"description": "Unauthorized
Possible error codes: ERR_AUTH_INVALID_CSRF, ERR_AUTH_UNAUTHORIZED",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
},
"examples": {
"ERR_AUTH_INVALID_CSRF": {
"summary": "Invalid CSRF Authentication",
"description": "Invalid CSRF Authentication",
"value": {
"errors": [
{
"code": "ERR_AUTH_INVALID_CSRF",
"message": "Invalid CSRF Authentication"
}
]
}
},
"ERR_AUTH_UNAUTHORIZED": {
"summary": "Unauthorized",
"description": "Unauthorized",
"value": {
"errors": [
{
"code": "ERR_AUTH_UNAUTHORIZED",
"message": "Unauthorized"
}
]
}
}
}
}
}
},
"403": {
"description": "Forbidden
Possible error codes: ERR_ACCESS_USER, ERR_ENTITY_DELETED, ERR_INPUT_IS_OWNER, ERR_ENTITY_PARENT_FOLDER_MEMBER_EXISTS",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
},
"examples": {
"ERR_ACCESS_USER": {
"summary": "Insufficient access permissions",
"description": "Insufficient access permissions",
"value": {
"errors": [
{
"code": "ERR_ACCESS_USER",
"message": "Insufficient access permissions"
}
]
}
},
"ERR_ENTITY_DELETED": {
"summary": "Entity is deleted",
"description": "Entity is deleted",
"value": {
"errors": [
{
"code": "ERR_ENTITY_DELETED",
"message": "Entity is deleted"
}
]
}
},
"ERR_INPUT_IS_OWNER": {
"summary": "Can not set owner role",
"description": "Can not set owner role",
"value": {
"errors": [
{
"code": "ERR_INPUT_IS_OWNER",
"message": "Can not set owner role"
}
]
}
},
"ERR_ENTITY_PARENT_FOLDER_MEMBER_EXISTS": {
"summary": "Parent folder member exists",
"description": "Parent folder member exists",
"value": {
"errors": [
{
"code": "ERR_ENTITY_PARENT_FOLDER_MEMBER_EXISTS",
"message": "Parent folder member exists"
}
]
}
}
}
}
}
},
"422": {
"description": "Unprocessable Content
Possible error codes: ERR_INVALID_PARAMETER",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
},
"examples": {
"ERR_INVALID_PARAMETER": {
"summary": "Invalid Parameter Exception",
"description": "Invalid Parameter Exception",
"value": {
"errors": [
{
"code": "ERR_INVALID_PARAMETER",
"message": "Invalid Parameter Exception"
}
]
}
}
}
}
}
},
"490": {
"description": "Request blocked by WAF"
}
}
}
},
"/rest/devices/me/actions/logout": {
"delete": {
"summary": "Log out the current user",
"description": "### Description:\n Logs out the current user and invalidates the active session.\n### Precondition:\n User must have an active session.\n### Response:\n Returns logout confirmation details.\n",
"tags": [
"devices"
],
"responses": {
"200": {
"description": "The user has been successfully logged out.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Logout"
}
}
}
},
"401": {
"description": "Unauthorized
Possible error codes: ERR_AUTH_INVALID_CSRF, ERR_AUTH_UNAUTHORIZED",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
},
"examples": {
"ERR_AUTH_INVALID_CSRF": {
"summary": "Invalid CSRF Authentication",
"description": "Invalid CSRF Authentication",
"value": {
"errors": [
{
"code": "ERR_AUTH_INVALID_CSRF",
"message": "Invalid CSRF Authentication"
}
]
}
},
"ERR_AUTH_UNAUTHORIZED": {
"summary": "Unauthorized",
"description": "Unauthorized",
"value": {
"errors": [
{
"code": "ERR_AUTH_UNAUTHORIZED",
"message": "Unauthorized"
}
]
}
}
}
}
}
},
"490": {
"description": "Request blocked by WAF"
}
}
}
},
"/rest/files/members": {
"post": {
"summary": "Share files",
"description": "### Description:\n Shares specified files with multiple users.\n### Precondition:\n Must be assigned the `user_add` permission for the folder.\n### Response:\n Shares the files with the specified users.\n",
"tags": [
"files"
],
"parameters": [
{
"in": "query",
"name": "updateIfExists",
"required": false,
"description": "If set to `true`, updates the member if they already exist and have a different folder role.",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "partialSuccess",
"required": false,
"description": "If set to `true`, the operation will continue for the valid items even if some items result in failure.",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "downgradeNested",
"required": false,
"description": "If set to `true`, demote the user member role in all applicable nested folders.",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "returnEntity",
"required": false,
"description": "If true, includes the entity in the response body.",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "with",
"required": false,
"description": "Specifies additional fields to include in the response.",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "mode",
"required": false,
"description": "Determines the detail level of the response body.",
"schema": {
"type": "string",
"enum": [
"compact",
"full_no_links",
"full_with_links",
"full"
]
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FileMembersPostRequest"
}
}
}
},
"responses": {
"201": {
"description": "All files were successfully shared with the specified users.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FolderFileAddMembers"
}
}
}
},
"207": {
"description": "Files were partially shared \u2014 some users were added successfully while others failed.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FolderFileAddMembers"
}
}
}
},
"401": {
"description": "Unauthorized
Possible error codes: ERR_AUTH_INVALID_CSRF, ERR_AUTH_UNAUTHORIZED",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
},
"examples": {
"ERR_AUTH_INVALID_CSRF": {
"summary": "Invalid CSRF Authentication",
"description": "Invalid CSRF Authentication",
"value": {
"errors": [
{
"code": "ERR_AUTH_INVALID_CSRF",
"message": "Invalid CSRF Authentication"
}
]
}
},
"ERR_AUTH_UNAUTHORIZED": {
"summary": "Unauthorized",
"description": "Unauthorized",
"value": {
"errors": [
{
"code": "ERR_AUTH_UNAUTHORIZED",
"message": "Unauthorized"
}
]
}
}
}
}
}
},
"403": {
"description": "Forbidden
Possible error codes: ERR_ENTITY_IS_BASE_DIR, ERR_ENTITY_IS_MY_DIR, ERR_ENTITY_IS_SYNC_DIR, ERR_ENTITY_IS_SECURE_FOLDER, ERR_ACCESS_USER, ERR_LICENSE_MAX_USERS_COUNT_REACHED, ERR_USER_HAS_NO_USER_TYPE, ERR_USER_TYPE_NO_ACCESS, ERR_INPUT_EMAIL_IS_DISTRIBUTION_LIST, ERR_ENTITY_USER_HAS_INSUFFICIENT_PERMISSIONS, ERR_PROFILE_COLLABORATION_DISABLED, ERR_ENTITY_IS_OWNER, ERR_ENTITY_DELETED, ERR_CLIENT_OBJECT",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
},
"examples": {
"ERR_ENTITY_IS_BASE_DIR": {
"summary": "Operation not permitted on Base Folder",
"description": "Operation not permitted on Base Folder",
"value": {
"errors": [
{
"code": "ERR_ENTITY_IS_BASE_DIR",
"message": "Operation not permitted on Base Folder"
}
]
}
},
"ERR_ENTITY_IS_MY_DIR": {
"summary": "Operation not permitted on Tray Folder",
"description": "Operation not permitted on Tray Folder",
"value": {
"errors": [
{
"code": "ERR_ENTITY_IS_MY_DIR",
"message": "Operation not permitted on Tray Folder"
}
]
}
},
"ERR_ENTITY_IS_SYNC_DIR": {
"summary": "Operation not permitted on My Folder",
"description": "Operation not permitted on My Folder",
"value": {
"errors": [
{
"code": "ERR_ENTITY_IS_SYNC_DIR",
"message": "Operation not permitted on My Folder"
}
]
}
},
"ERR_ENTITY_IS_SECURE_FOLDER": {
"summary": "Operation not permitted on restricted Folder.",
"description": "Operation not permitted on restricted Folder.",
"value": {
"errors": [
{
"code": "ERR_ENTITY_IS_SECURE_FOLDER",
"message": "Operation not permitted on restricted Folder."
}
]
}
},
"ERR_ACCESS_USER": {
"summary": "Insufficient access permissions",
"description": "Insufficient access permissions",
"value": {
"errors": [
{
"code": "ERR_ACCESS_USER",
"message": "Insufficient access permissions"
}
]
}
},
"ERR_LICENSE_MAX_USERS_COUNT_REACHED": {
"summary": "License count has been reached",
"description": "License count has been reached",
"value": {
"errors": [
{
"code": "ERR_LICENSE_MAX_USERS_COUNT_REACHED",
"message": "License count has been reached"
}
]
}
},
"ERR_USER_HAS_NO_USER_TYPE": {
"summary": "User has no profile",
"description": "User has no profile",
"value": {
"errors": [
{
"code": "ERR_USER_HAS_NO_USER_TYPE",
"message": "User has no profile"
}
]
}
},
"ERR_USER_TYPE_NO_ACCESS": {
"summary": "Permission denied",
"description": "Permission denied",
"value": {
"errors": [
{
"code": "ERR_USER_TYPE_NO_ACCESS",
"message": "Permission denied"
}
]
}
},
"ERR_INPUT_EMAIL_IS_DISTRIBUTION_LIST": {
"summary": "Distribution list user is not allowed to register",
"description": "Distribution list user is not allowed to register",
"value": {
"errors": [
{
"code": "ERR_INPUT_EMAIL_IS_DISTRIBUTION_LIST",
"message": "Distribution list user is not allowed to register"
}
]
}
},
"ERR_ENTITY_USER_HAS_INSUFFICIENT_PERMISSIONS": {
"summary": "Target user has insufficient access permissions",
"description": "Target user has insufficient access permissions",
"value": {
"errors": [
{
"code": "ERR_ENTITY_USER_HAS_INSUFFICIENT_PERMISSIONS",
"message": "Target user has insufficient access permissions"
}
]
}
},
"ERR_PROFILE_COLLABORATION_DISABLED": {
"summary": "User's profile has no collaboration access",
"description": "User's profile has no collaboration access",
"value": {
"errors": [
{
"code": "ERR_PROFILE_COLLABORATION_DISABLED",
"message": "User's profile has no collaboration access"
}
]
}
},
"ERR_ENTITY_IS_OWNER": {
"summary": "Operation not permitted on owner member",
"description": "Operation not permitted on owner member",
"value": {
"errors": [
{
"code": "ERR_ENTITY_IS_OWNER",
"message": "Operation not permitted on owner member"
}
]
}
},
"ERR_ENTITY_DELETED": {
"summary": "Entity is deleted",
"description": "Entity is deleted",
"value": {
"errors": [
{
"code": "ERR_ENTITY_DELETED",
"message": "Entity is deleted"
}
]
}
},
"ERR_CLIENT_OBJECT": {
"summary": "Operation is not allowed on this client object",
"description": "Operation is not allowed on this client object",
"value": {
"errors": [
{
"code": "ERR_CLIENT_OBJECT",
"message": "Operation is not allowed on this client object"
}
]
}
}
}
}
}
},
"409": {
"description": "Conflict
Possible error codes: ERR_ENTITY_EXISTS, ERR_ENTITY_ROLE_IS_ASSIGNED",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
},
"examples": {
"ERR_ENTITY_EXISTS": {
"summary": "Entity exists",
"description": "Entity exists",
"value": {
"errors": [
{
"code": "ERR_ENTITY_EXISTS",
"message": "Entity exists"
}
]
}
},
"ERR_ENTITY_ROLE_IS_ASSIGNED": {
"summary": "Cannot assign already assigned role",
"description": "Cannot assign already assigned role",
"value": {
"errors": [
{
"code": "ERR_ENTITY_ROLE_IS_ASSIGNED",
"message": "Cannot assign already assigned role"
}
]
}
}
}
}
}
},
"490": {
"description": "Request blocked by WAF"
}
}
}
},
"/rest/files/shared": {
"get": {
"summary": "Get shared files",
"description": "### Description:\n Gets a list of files that have been shared with the user. For each file, the file name, size, and date the file was shared is returned.\n### Precondition:\n If the user is assigned the Restricted profile, the \"Collaboration Allowed\" setting must be turned on to get results.\n### Response:\n Returns the list of files that have been shared with the user.\n### Sorting:\n Sorting can be applied using two query parameters: `orderBy` for the field name,\n and `orderType` for the sort order, which can be either `asc` or `desc`.\n### Sorting field options:\n | FIELD_NAME | Description |\n |------------|-------------|\n | name | The name of the file |\n | size | The size of the file |\n | shared | The datetime when the file was shared |\n",
"tags": [
"files"
],
"parameters": [
{
"in": "query",
"name": "orderBy",
"required": false,
"description": "Field to sort by. Default is `shared`.
Allowed values: `name`, `size`, `shared`, `sharedBy`, `modified`.",
"schema": {
"type": "string",
"enum": [
"name",
"size",
"shared",
"sharedBy",
"modified"
]
}
},
{
"in": "query",
"name": "orderType",
"required": false,
"description": "Sort direction. `asc` for ascending, `desc` for descending. Default is `desc`.",
"schema": {
"type": "string",
"enum": [
"asc",
"desc"
]
}
},
{
"in": "query",
"name": "limit",
"required": false,
"description": "Range limit.",
"schema": {
"type": "integer",
"minimum": 1
}
},
{
"in": "query",
"name": "offset",
"required": false,
"description": "Range offset.",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"in": "query",
"name": "with",
"required": false,
"description": "Specifies additional fields to include in the response.",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "mode",
"required": false,
"description": "Determines the detail level of the response body.",
"schema": {
"type": "string",
"enum": [
"compact",
"full_no_links",
"full_with_links",
"full"
]
}
}
],
"responses": {
"200": {
"description": "Successfully returned the list of files shared with the user.",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/File"
}
}
}
}
},
"401": {
"description": "Unauthorized
Possible error codes: ERR_AUTH_INVALID_CSRF, ERR_AUTH_UNAUTHORIZED",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
},
"examples": {
"ERR_AUTH_INVALID_CSRF": {
"summary": "Invalid CSRF Authentication",
"description": "Invalid CSRF Authentication",
"value": {
"errors": [
{
"code": "ERR_AUTH_INVALID_CSRF",
"message": "Invalid CSRF Authentication"
}
]
}
},
"ERR_AUTH_UNAUTHORIZED": {
"summary": "Unauthorized",
"description": "Unauthorized",
"value": {
"errors": [
{
"code": "ERR_AUTH_UNAUTHORIZED",
"message": "Unauthorized"
}
]
}
}
}
}
}
},
"422": {
"description": "Unprocessable Content
Possible error codes: ERR_INVALID_PARAMETER",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
},
"examples": {
"ERR_INVALID_PARAMETER": {
"summary": "Invalid Parameter Exception",
"description": "Invalid Parameter Exception",
"value": {
"errors": [
{
"code": "ERR_INVALID_PARAMETER",
"message": "Invalid Parameter Exception"
}
]
}
}
}
}
}
},
"490": {
"description": "Request blocked by WAF"
}
}
}
},
"/rest/files/{id}/members/me": {
"delete": {
"summary": "Remove access to shared file",
"description": "### Description:\n Removes the current user's access to the specified file that was shared with them.\n### Precondition:\n The file must have been shared with the user.\n### Response:\n Removes the user's access to the shared file.\n",
"tags": [
"files"
],
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"description": "The unique identifier (UUID) of the entity.",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "The user has been successfully removed from the file."
},
"401": {
"description": "Unauthorized
Possible error codes: ERR_AUTH_INVALID_CSRF, ERR_AUTH_UNAUTHORIZED",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
},
"examples": {
"ERR_AUTH_INVALID_CSRF": {
"summary": "Invalid CSRF Authentication",
"description": "Invalid CSRF Authentication",
"value": {
"errors": [
{
"code": "ERR_AUTH_INVALID_CSRF",
"message": "Invalid CSRF Authentication"
}
]
}
},
"ERR_AUTH_UNAUTHORIZED": {
"summary": "Unauthorized",
"description": "Unauthorized",
"value": {
"errors": [
{
"code": "ERR_AUTH_UNAUTHORIZED",
"message": "Unauthorized"
}
]
}
}
}
}
}
},
"403": {
"description": "Forbidden
Possible error codes: ERR_ACCESS_USER, ERR_ENTITY_DELETED",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
},
"examples": {
"ERR_ACCESS_USER": {
"summary": "Insufficient access permissions",
"description": "Insufficient access permissions",
"value": {
"errors": [
{
"code": "ERR_ACCESS_USER",
"message": "Insufficient access permissions"
}
]
}
},
"ERR_ENTITY_DELETED": {
"summary": "Entity is deleted",
"description": "Entity is deleted",
"value": {
"errors": [
{
"code": "ERR_ENTITY_DELETED",
"message": "Entity is deleted"
}
]
}
}
}
}
}
},
"422": {
"description": "Unprocessable Content
Possible error codes: ERR_INVALID_PARAMETER",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
},
"examples": {
"ERR_INVALID_PARAMETER": {
"summary": "Invalid Parameter Exception",
"description": "Invalid Parameter Exception",
"value": {
"errors": [
{
"code": "ERR_INVALID_PARAMETER",
"message": "Invalid Parameter Exception"
}
]
}
}
}
}
}
},
"490": {
"description": "Request blocked by WAF"
}
}
}
},
"/rest/files/previewSupport": {
"get": {
"summary": "Get file preview status",
"description": "### Description:\n Gets the status of the specified file to determine if the file type is supported for preview.\n### Precondition:\n Must be assigned the `view` permission for the folder.\n### Response:\n Returns confirmation as to whether the file type is supported for preview.\n",
"tags": [
"files"
],
"parameters": [
{
"in": "query",
"name": "id:in",
"required": true,
"explode": true,
"style": "form",
"description": "Comma-separated list of file UUIDs to check for preview support.",
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
}
],
"responses": {
"200": {
"description": "Returns a list of unique identifiers (UUIDs) of the files supported for preview.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FilePreviewSupport"
}
}
}
},
"400": {
"description": "Bad Request
Possible error codes: ERR_REQUEST_INVALID_FILTER",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
},
"examples": {
"ERR_REQUEST_INVALID_FILTER": {
"summary": "Filter validation failed",
"description": "Filter validation failed",
"value": {
"errors": [
{
"code": "ERR_REQUEST_INVALID_FILTER",
"message": "Filter validation failed"
}
]
}
}
}
}
}
},
"401": {
"description": "Unauthorized
Possible error codes: ERR_AUTH_INVALID_CSRF, ERR_AUTH_UNAUTHORIZED",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
},
"examples": {
"ERR_AUTH_INVALID_CSRF": {
"summary": "Invalid CSRF Authentication",
"description": "Invalid CSRF Authentication",
"value": {
"errors": [
{
"code": "ERR_AUTH_INVALID_CSRF",
"message": "Invalid CSRF Authentication"
}
]
}
},
"ERR_AUTH_UNAUTHORIZED": {
"summary": "Unauthorized",
"description": "Unauthorized",
"value": {
"errors": [
{
"code": "ERR_AUTH_UNAUTHORIZED",
"message": "Unauthorized"
}
]
}
}
}
}
}
},
"490": {
"description": "Request blocked by WAF"
}
}
}
},
"/rest/files/actions/downloadLink": {
"post": {
"summary": "Get link for downloading files and folders",
"description": "### Description:\n Generates a link for downloading specified folders and files.\n### Precondition:\n Must be assigned the download permission for the specified files and folders.\n### Response:\n A download link is generated and returned.\n Returns the link for downloading the files and folders, once files complete security scans. Depending on system scan policies, files will be scanned for anti-virus, data loss prevention, and advanced threat protection.\n",
"tags": [
"files"
],
"parameters": [
{
"in": "query",
"name": "partialSuccess",
"required": false,
"description": "Indicates whether the operation should proceed if some files/folders fail the check.",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "extensions",
"required": false,
"explode": true,
"style": "form",
"description": "Filter results to include only files with the specified comma-separated list of extensions.",
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PostFileZipStatusBodyRequest"
}
}
}
},
"responses": {
"200": {
"description": "The download link has been successfully generated.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DownloadLink"
}
}
}
},
"400": {
"description": "Bad Request
Possible error codes: ERR_REQUEST_INVALID_FILTER",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
},
"examples": {
"ERR_REQUEST_INVALID_FILTER": {
"summary": "Filter validation failed",
"description": "Filter validation failed",
"value": {
"errors": [
{
"code": "ERR_REQUEST_INVALID_FILTER",
"message": "Filter validation failed"
}
]
}
}
}
}
}
},
"401": {
"description": "Unauthorized
Possible error codes: ERR_AUTH_UNAUTHORIZED",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
},
"examples": {
"ERR_AUTH_UNAUTHORIZED": {
"summary": "Unauthorized",
"description": "Unauthorized",
"value": {
"errors": [
{
"code": "ERR_AUTH_UNAUTHORIZED",
"message": "Unauthorized"
}
]
}
}
}
}
}
},
"422": {
"description": "Unprocessable Content
Possible error codes: ERR_INVALID_PARAMETER",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
},
"examples": {
"ERR_INVALID_PARAMETER": {
"summary": "Invalid Parameter Exception",
"description": "Invalid Parameter Exception",
"value": {
"errors": [
{
"code": "ERR_INVALID_PARAMETER",
"message": "Invalid Parameter Exception"
}
]
}
}
}
}
}
},
"490": {
"description": "Request blocked by WAF"
}
}
}
},
"/rest/externalDL": {
"post": {
"summary": "Add external distribution lists",
"description": "### Description:\n Adds one or more email addresses to the current user's external distribution lists.\n### Precondition:\n User must be authenticated.\n### Response:\n The external distribution lists are created and returned.\n",
"tags": [
"externalDL"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ExternalDLUpdateRequest"
}
}
}
},
"responses": {
"201": {
"description": "The external distribution lists have been successfully added.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ExternalDLs"
}
}
}
},
"401": {
"description": "Unauthorized
Possible error codes: ERR_ACCESS_USER, ERR_AUTH_INVALID_CSRF, ERR_AUTH_UNAUTHORIZED",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
},
"examples": {
"ERR_ACCESS_USER": {
"summary": "Insufficient access permissions",
"description": "Insufficient access permissions",
"value": {
"errors": [
{
"code": "ERR_ACCESS_USER",
"message": "Insufficient access permissions"
}
]
}
},
"ERR_AUTH_INVALID_CSRF": {
"summary": "Invalid CSRF Authentication",
"description": "Invalid CSRF Authentication",
"value": {
"errors": [
{
"code": "ERR_AUTH_INVALID_CSRF",
"message": "Invalid CSRF Authentication"
}
]
}
},
"ERR_AUTH_UNAUTHORIZED": {
"summary": "Unauthorized",
"description": "Unauthorized",
"value": {
"errors": [
{
"code": "ERR_AUTH_UNAUTHORIZED",
"message": "Unauthorized"
}
]
}
}
}
}
}
},
"403": {
"description": "Forbidden
Possible error codes: ERR_ACCESS_DENIED",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
},
"examples": {
"ERR_ACCESS_DENIED": {
"summary": "Your access is denied.",
"description": "Your access is denied.",
"value": {
"errors": [
{
"code": "ERR_ACCESS_DENIED",
"message": "Your access is denied.",
"redirectUrl": "/login?code=3317"
}
]
}
}
}
}
}
},
"490": {
"description": "Request blocked by WAF"
}
}
},
"get": {
"summary": "List external distribution lists",
"description": "### Description:\n Returns the list of external distribution lists for the current user.\n### Precondition:\n User must be authenticated.\n### Response:\n The list of external distribution lists is returned.\n",
"tags": [
"externalDL"
],
"parameters": [
{
"in": "query",
"name": "search",
"required": false,
"description": "Search term to filter external distribution lists by email address.",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "The external distribution lists have been successfully returned.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ExternalDLs"
}
}
}
},
"401": {
"description": "Unauthorized
Possible error codes: ERR_ACCESS_USER, ERR_AUTH_INVALID_CSRF, ERR_AUTH_UNAUTHORIZED",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
},
"examples": {
"ERR_ACCESS_USER": {
"summary": "Insufficient access permissions",
"description": "Insufficient access permissions",
"value": {
"errors": [
{
"code": "ERR_ACCESS_USER",
"message": "Insufficient access permissions"
}
]
}
},
"ERR_AUTH_INVALID_CSRF": {
"summary": "Invalid CSRF Authentication",
"description": "Invalid CSRF Authentication",
"value": {
"errors": [
{
"code": "ERR_AUTH_INVALID_CSRF",
"message": "Invalid CSRF Authentication"
}
]
}
},
"ERR_AUTH_UNAUTHORIZED": {
"summary": "Unauthorized",
"description": "Unauthorized",
"value": {
"errors": [
{
"code": "ERR_AUTH_UNAUTHORIZED",
"message": "Unauthorized"
}
]
}
}
}
}
}
},
"403": {
"description": "Forbidden
Possible error codes: ERR_ACCESS_DENIED",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
},
"examples": {
"ERR_ACCESS_DENIED": {
"summary": "Your access is denied.",
"description": "Your access is denied.",
"value": {
"errors": [
{
"code": "ERR_ACCESS_DENIED",
"message": "Your access is denied.",
"redirectUrl": "/login?code=3317"
}
]
}
}
}
}
}
},
"490": {
"description": "Request blocked by WAF"
}
}
},
"delete": {
"summary": "Delete external distribution lists",
"description": "### Description:\n Removes one or more email addresses from the current user's external distribution lists.\n### Precondition:\n User must be authenticated.\n### Response:\n The specified external distribution lists are deleted.\n",
"tags": [
"externalDL"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ExternalDLUpdateRequest"
}
}
}
},
"responses": {
"200": {
"description": "The external distribution lists have been successfully deleted.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ExternalDLs"
}
}
}
},
"401": {
"description": "Unauthorized
Possible error codes: ERR_ACCESS_USER, ERR_AUTH_INVALID_CSRF, ERR_AUTH_UNAUTHORIZED",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
},
"examples": {
"ERR_ACCESS_USER": {
"summary": "Insufficient access permissions",
"description": "Insufficient access permissions",
"value": {
"errors": [
{
"code": "ERR_ACCESS_USER",
"message": "Insufficient access permissions"
}
]
}
},
"ERR_AUTH_INVALID_CSRF": {
"summary": "Invalid CSRF Authentication",
"description": "Invalid CSRF Authentication",
"value": {
"errors": [
{
"code": "ERR_AUTH_INVALID_CSRF",
"message": "Invalid CSRF Authentication"
}
]
}
},
"ERR_AUTH_UNAUTHORIZED": {
"summary": "Unauthorized",
"description": "Unauthorized",
"value": {
"errors": [
{
"code": "ERR_AUTH_UNAUTHORIZED",
"message": "Unauthorized"
}
]
}
}
}
}
}
},
"403": {
"description": "Forbidden
Possible error codes: ERR_ACCESS_DENIED",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
},
"examples": {
"ERR_ACCESS_DENIED": {
"summary": "Your access is denied.",
"description": "Your access is denied.",
"value": {
"errors": [
{
"code": "ERR_ACCESS_DENIED",
"message": "Your access is denied.",
"redirectUrl": "/login?code=3317"
}
]
}
}
}
}
}
},
"490": {
"description": "Request blocked by WAF"
}
}
}
},
"/rest/sources/{id}/query": {
"get": {
"summary": "Search SharePoint sites",
"description": "### Description:\n Searches for SharePoint sites accessible through the specified source connection.\n### Precondition:\n User must have a valid SharePoint Online source connection configured.\n### Response:\n Returns a list of matching SharePoint sites.\n",
"tags": [
"search"
],
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"description": "The unique identifier of the entity.",
"schema": {
"type": "integer"
}
},
{
"in": "query",
"name": "include_kw",
"required": false,
"description": "If true, includes Kiteworks native sources in the results.",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "include_container",
"required": false,
"description": "If true, includes container-type sources (e.g. SharePoint document libraries) in the results.",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "limit",
"required": false,
"description": "Maximum number of results to return.",
"schema": {
"type": "integer"
}
},
{
"in": "query",
"name": "offset",
"required": false,
"description": "Number of results to skip before returning results, for pagination.",
"schema": {
"type": "integer"
}
},
{
"in": "query",
"name": "query",
"required": false,
"description": "Search query string to filter sources or sites by name.",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "search_type",
"required": false,
"description": "Type of search to perform against the source.",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "SharePoint sites have been successfully returned.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SearchSharePointSitesResult"
}
}
}
},
"401": {
"description": "Unauthorized
Possible error codes: ERR_AUTH_INVALID_CSRF, ERR_AUTH_UNAUTHORIZED",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
},
"examples": {
"ERR_AUTH_INVALID_CSRF": {
"summary": "Invalid CSRF Authentication",
"description": "Invalid CSRF Authentication",
"value": {
"errors": [
{
"code": "ERR_AUTH_INVALID_CSRF",
"message": "Invalid CSRF Authentication"
}
]
}
},
"ERR_AUTH_UNAUTHORIZED": {
"summary": "Unauthorized",
"description": "Unauthorized",
"value": {
"errors": [
{
"code": "ERR_AUTH_UNAUTHORIZED",
"message": "Unauthorized"
}
]
}
}
}
}
}
},
"403": {
"description": "Forbidden
Possible error codes: ERR_AUTH_EC_UPDATE_TOKEN, ERR_SPO_SEARCH",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
},
"examples": {
"ERR_AUTH_EC_UPDATE_TOKEN": {
"summary": "Token update/receive required",
"description": "Token update/receive required",
"value": {
"errors": [
{
"code": "ERR_AUTH_EC_UPDATE_TOKEN",
"message": "Token update/receive required"
}
]
}
},
"ERR_SPO_SEARCH": {
"summary": "Unable to call SPO Search API",
"description": "Unable to call SPO Search API",
"value": {
"errors": [
{
"code": "ERR_SPO_SEARCH",
"message": "Unable to call SPO Search API"
}
]
}
}
}
}
}
},
"490": {
"description": "Request blocked by WAF"
}
}
}
},
"/rest/sharedMailboxes": {
"patch": {
"summary": "Update current user's shared mailbox active status",
"description": "### Description:\n Updates the active status of one or more shared mailboxes for the current user.\n### Precondition:\n The user must be authenticated and belong to an internal domain.\n### Response:\n The updated list of shared mailboxes is returned.\n",
"tags": [
"sharedMailbox"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SharedMailboxStatusPatchRequest"
}
}
}
},
"responses": {
"200": {
"description": "The shared mailbox status is updated successfully.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SharedMailboxList"
}
}
}
},
"401": {
"description": "Unauthorized
Possible error codes: ERR_AUTH_INVALID_CSRF, ERR_AUTH_UNAUTHORIZED",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
},
"examples": {
"ERR_AUTH_INVALID_CSRF": {
"summary": "Invalid CSRF Authentication",
"description": "Invalid CSRF Authentication",
"value": {
"errors": [
{
"code": "ERR_AUTH_INVALID_CSRF",
"message": "Invalid CSRF Authentication"
}
]
}
},
"ERR_AUTH_UNAUTHORIZED": {
"summary": "Unauthorized",
"description": "Unauthorized",
"value": {
"errors": [
{
"code": "ERR_AUTH_UNAUTHORIZED",
"message": "Unauthorized"
}
]
}
}
}
}
}
},
"403": {
"description": "Forbidden
Possible error codes: ERR_ACCESS_USER, ERR_NOT_INTERNAL_DOMAIN",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
},
"examples": {
"ERR_ACCESS_USER": {
"summary": "Insufficient access permissions",
"description": "Insufficient access permissions",
"value": {
"errors": [
{
"code": "ERR_ACCESS_USER",
"message": "Insufficient access permissions"
}
]
}
},
"ERR_NOT_INTERNAL_DOMAIN": {
"summary": "The email is not internal domain",
"description": "The email is not internal domain",
"value": {
"errors": [
{
"code": "ERR_NOT_INTERNAL_DOMAIN",
"message": "The email is not internal domain"
}
]
}
}
}
}
}
},
"422": {
"description": "Unprocessable Content
Possible error codes: ERR_MAX_ACTIVED_SHAREDMAILBOX",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
},
"examples": {
"ERR_MAX_ACTIVED_SHAREDMAILBOX": {
"summary": "Maximum activated shared mailbox reached",
"description": "Maximum activated shared mailbox reached",
"value": {
"errors": [
{
"code": "ERR_MAX_ACTIVED_SHAREDMAILBOX",
"message": "Maximum activated shared mailbox reached"
}
]
}
}
}
}
}
},
"490": {
"description": "Request blocked by WAF"
}
}
},
"get": {
"summary": "Return current user's shared mailboxes",
"description": "### Description:\n Returns a paginated list of shared mailboxes available to the current user.\n### Precondition:\n The user must be authenticated and belong to an internal domain.\n### Response:\n A list of shared mailboxes is returned.\n",
"tags": [
"sharedMailbox"
],
"parameters": [
{
"in": "query",
"name": "orderBy",
"required": false,
"description": "Sort order for the results.
Allowed values: `modified:asc`, `modified:desc`, `active:asc`, `active:desc`.",
"schema": {
"type": "string",
"enum": [
"modified:asc",
"modified:desc",
"active:asc",
"active:desc"
]
}
},
{
"in": "query",
"name": "limit",
"required": false,
"description": "Maximum number of results to return.",
"schema": {
"type": "integer",
"minimum": 1
}
},
{
"in": "query",
"name": "offset",
"required": false,
"description": "Number of items to skip before returning results, for pagination.",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"in": "query",
"name": "active",
"required": false,
"description": "Filter by active status. If true, returns only active shared mailboxes; if false, returns only inactive ones.",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "id:in",
"required": false,
"explode": true,
"style": "form",
"description": "Comma-separated list of shared mailbox user IDs to filter by. (Recommended request size <= 100)",
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
}
],
"responses": {
"200": {
"description": "The shared mailboxes are returned successfully.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SharedMailboxList"
}
}
}
},
"401": {
"description": "Unauthorized
Possible error codes: ERR_AUTH_INVALID_CSRF, ERR_AUTH_UNAUTHORIZED",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
},
"examples": {
"ERR_AUTH_INVALID_CSRF": {
"summary": "Invalid CSRF Authentication",
"description": "Invalid CSRF Authentication",
"value": {
"errors": [
{
"code": "ERR_AUTH_INVALID_CSRF",
"message": "Invalid CSRF Authentication"
}
]
}
},
"ERR_AUTH_UNAUTHORIZED": {
"summary": "Unauthorized",
"description": "Unauthorized",
"value": {
"errors": [
{
"code": "ERR_AUTH_UNAUTHORIZED",
"message": "Unauthorized"
}
]
}
}
}
}
}
},
"403": {
"description": "Forbidden
Possible error codes: ERR_NOT_INTERNAL_DOMAIN",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
},
"examples": {
"ERR_NOT_INTERNAL_DOMAIN": {
"summary": "The email is not internal domain",
"description": "The email is not internal domain",
"value": {
"errors": [
{
"code": "ERR_NOT_INTERNAL_DOMAIN",
"message": "The email is not internal domain"
}
]
}
}
}
}
}
},
"490": {
"description": "Request blocked by WAF"
}
}
}
},
"/rest/sharedMailboxes/mail/actions/counters": {
"get": {
"summary": "Return current user's shared mailbox counters",
"description": "### Description:\n Returns unread message counters for the current user's active shared mailboxes.\n### Precondition:\n The user must be authenticated.\n### Response:\n A list of mail counters for each active shared mailbox is returned.\n",
"tags": [
"sharedMailbox"
],
"parameters": [
{
"in": "query",
"name": "id:in",
"required": false,
"explode": true,
"style": "form",
"description": "Comma-separated list of shared mailbox user IDs to filter by. (Recommended request size <= 100)",
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
}
],
"responses": {
"200": {
"description": "The shared mailbox counters are returned successfully.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MailCountersList"
}
}
}
},
"401": {
"description": "Unauthorized
Possible error codes: ERR_AUTH_INVALID_CSRF, ERR_AUTH_UNAUTHORIZED",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
},
"examples": {
"ERR_AUTH_INVALID_CSRF": {
"summary": "Invalid CSRF Authentication",
"description": "Invalid CSRF Authentication",
"value": {
"errors": [
{
"code": "ERR_AUTH_INVALID_CSRF",
"message": "Invalid CSRF Authentication"
}
]
}
},
"ERR_AUTH_UNAUTHORIZED": {
"summary": "Unauthorized",
"description": "Unauthorized",
"value": {
"errors": [
{
"code": "ERR_AUTH_UNAUTHORIZED",
"message": "Unauthorized"
}
]
}
}
}
}
}
},
"403": {
"description": "Forbidden
Possible error codes: ERR_ACCESS_USER",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
},
"examples": {
"ERR_ACCESS_USER": {
"summary": "Insufficient access permissions",
"description": "Insufficient access permissions",
"value": {
"errors": [
{
"code": "ERR_ACCESS_USER",
"message": "Insufficient access permissions"
}
]
}
}
}
}
}
},
"490": {
"description": "Request blocked by WAF"
}
}
}
},
"/rest/sharedMailboxes/{id}/settings": {
"get": {
"summary": "Return shared mailbox settings",
"description": "### Description:\n Returns the application settings for the specified shared mailbox.\n### Precondition:\n The user must be authenticated and the specified shared mailbox must be active.\n### Response:\n The shared mailbox settings are returned.\n",
"tags": [
"sharedMailbox"
],
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"description": "The unique identifier (UUID) of the user.",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "The shared mailbox settings are returned successfully.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SharedMailboxSetting"
}
}
}
},
"401": {
"description": "Unauthorized
Possible error codes: ERR_AUTH_INVALID_CSRF, ERR_AUTH_UNAUTHORIZED",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
},
"examples": {
"ERR_AUTH_INVALID_CSRF": {
"summary": "Invalid CSRF Authentication",
"description": "Invalid CSRF Authentication",
"value": {
"errors": [
{
"code": "ERR_AUTH_INVALID_CSRF",
"message": "Invalid CSRF Authentication"
}
]
}
},
"ERR_AUTH_UNAUTHORIZED": {
"summary": "Unauthorized",
"description": "Unauthorized",
"value": {
"errors": [
{
"code": "ERR_AUTH_UNAUTHORIZED",
"message": "Unauthorized"
}
]
}
}
}
}
}
},
"403": {
"description": "Forbidden
Possible error codes: ERR_ACCESS_USER",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
},
"examples": {
"ERR_ACCESS_USER": {
"summary": "Insufficient access permissions",
"description": "Insufficient access permissions",
"value": {
"errors": [
{
"code": "ERR_ACCESS_USER",
"message": "Insufficient access permissions"
}
]
}
}
}
}
}
},
"490": {
"description": "Request blocked by WAF"
}
}
}
},
"/rest/sharedMailboxes/{id}/webForms": {
"get": {
"summary": "List web forms available to a shared mailbox",
"description": "### Description:\n Returns a list of web forms available to the specified shared mailbox.\n### Precondition:\n The user must be authenticated and the specified shared mailbox must be active.\n### Response:\n A list of web forms is returned.\n",
"tags": [
"sharedMailbox"
],
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"description": "The unique identifier (UUID) of the user.",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "query",
"name": "returnEntity",
"required": false,
"description": "If true, includes the entity in the response body.",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "with",
"required": false,
"description": "Specifies additional fields to include in the response.",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "mode",
"required": false,
"description": "Determines the detail level of the response body.",
"schema": {
"type": "string",
"enum": [
"compact",
"full_no_links",
"full_with_links",
"full"
]
}
}
],
"responses": {
"200": {
"description": "The web forms are returned successfully.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WebFormList"
}
}
}
},
"401": {
"description": "Unauthorized
Possible error codes: ERR_AUTH_INVALID_CSRF, ERR_AUTH_UNAUTHORIZED",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
},
"examples": {
"ERR_AUTH_INVALID_CSRF": {
"summary": "Invalid CSRF Authentication",
"description": "Invalid CSRF Authentication",
"value": {
"errors": [
{
"code": "ERR_AUTH_INVALID_CSRF",
"message": "Invalid CSRF Authentication"
}
]
}
},
"ERR_AUTH_UNAUTHORIZED": {
"summary": "Unauthorized",
"description": "Unauthorized",
"value": {
"errors": [
{
"code": "ERR_AUTH_UNAUTHORIZED",
"message": "Unauthorized"
}
]
}
}
}
}
}
},
"403": {
"description": "Forbidden
Possible error codes: ERR_ACCESS_USER",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
},
"examples": {
"ERR_ACCESS_USER": {
"summary": "Insufficient access permissions",
"description": "Insufficient access permissions",
"value": {
"errors": [
{
"code": "ERR_ACCESS_USER",
"message": "Insufficient access permissions"
}
]
}
}
}
}
}
},
"490": {
"description": "Request blocked by WAF"
}
}
}
},
"/rest/userSshPublicKeys/create": {
"post": {
"summary": "Register an SSH public key for the current user",
"description": "### Description:\n Registers an existing SSH public key for the current user.\n### Precondition:\n SFTP access must be enabled for the user's profile and role.\n### Response:\n The SSH public key is registered.\n",
"tags": [
"userSshPublicKeys"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UserSshPublicKeysPostCreateRequest"
}
}
}
},
"responses": {
"201": {
"description": "The SSH public key was successfully registered."
},
"401": {
"description": "Unauthorized
Possible error codes: ERR_AUTH_INVALID_CSRF, ERR_AUTH_UNAUTHORIZED",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
},
"examples": {
"ERR_AUTH_INVALID_CSRF": {
"summary": "Invalid CSRF Authentication",
"description": "Invalid CSRF Authentication",
"value": {
"errors": [
{
"code": "ERR_AUTH_INVALID_CSRF",
"message": "Invalid CSRF Authentication"
}
]
}
},
"ERR_AUTH_UNAUTHORIZED": {
"summary": "Unauthorized",
"description": "Unauthorized",
"value": {
"errors": [
{
"code": "ERR_AUTH_UNAUTHORIZED",
"message": "Unauthorized"
}
]
}
}
}
}
}
},
"403": {
"description": "Forbidden
Possible error codes: ERR_ACCESS_USER, ERR_PROFILE_SFTP_DISABLED, ERR_SYSTEM_ROLE_SFTP_DISABLED",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
},
"examples": {
"ERR_ACCESS_USER": {
"summary": "Insufficient access permissions",
"description": "Insufficient access permissions",
"value": {
"errors": [
{
"code": "ERR_ACCESS_USER",
"message": "Insufficient access permissions"
}
]
}
},
"ERR_PROFILE_SFTP_DISABLED": {
"summary": "SFTP is not enabled for this profile",
"description": "SFTP is not enabled for this profile",
"value": {
"errors": [
{
"code": "ERR_PROFILE_SFTP_DISABLED",
"message": "SFTP is not enabled for this profile"
}
]
}
},
"ERR_SYSTEM_ROLE_SFTP_DISABLED": {
"summary": "SFTP role is not enabled on server",
"description": "SFTP role is not enabled on server",
"value": {
"errors": [
{
"code": "ERR_SYSTEM_ROLE_SFTP_DISABLED",
"message": "SFTP role is not enabled on server"
}
]
}
}
}
}
}
},
"422": {
"description": "Unprocessable Content
Possible error codes: ERR_INVALID_PARAMETER, ERR_SSH_PUBLIC_KEY_EXISTS",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
},
"examples": {
"ERR_INVALID_PARAMETER": {
"summary": "Invalid Parameter Exception",
"description": "Invalid Parameter Exception",
"value": {
"errors": [
{
"code": "ERR_INVALID_PARAMETER",
"message": "Invalid Parameter Exception"
}
]
}
},
"ERR_SSH_PUBLIC_KEY_EXISTS": {
"summary": "Same ssh public key name exists",
"description": "Same ssh public key name exists",
"value": {
"errors": [
{
"code": "ERR_SSH_PUBLIC_KEY_EXISTS",
"message": "Same ssh public key name exists"
}
]
}
}
}
}
}
},
"490": {
"description": "Request blocked by WAF"
}
}
}
},
"/rest/userSshPublicKeys/generate": {
"post": {
"summary": "Generate a new SSH public/private key pair",
"description": "### Description:\n Generates a new SSH public/private key pair for the current user and registers the public key.\n### Precondition:\n SFTP access must be enabled for the user's profile and role.\n### Response:\n The generated SSH public/private key pair is returned.\n",
"tags": [
"userSshPublicKeys"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UserSshPublicKeysPostGenerateRequest"
}
}
}
},
"responses": {
"201": {
"description": "The SSH key pair was successfully generated.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UserGeneratedSshPublicKeyKey"
}
}
}
},
"401": {
"description": "Unauthorized
Possible error codes: ERR_AUTH_INVALID_CSRF, ERR_AUTH_UNAUTHORIZED",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
},
"examples": {
"ERR_AUTH_INVALID_CSRF": {
"summary": "Invalid CSRF Authentication",
"description": "Invalid CSRF Authentication",
"value": {
"errors": [
{
"code": "ERR_AUTH_INVALID_CSRF",
"message": "Invalid CSRF Authentication"
}
]
}
},
"ERR_AUTH_UNAUTHORIZED": {
"summary": "Unauthorized",
"description": "Unauthorized",
"value": {
"errors": [
{
"code": "ERR_AUTH_UNAUTHORIZED",
"message": "Unauthorized"
}
]
}
}
}
}
}
},
"403": {
"description": "Forbidden
Possible error codes: ERR_ACCESS_USER, ERR_PROFILE_SFTP_DISABLED, ERR_SYSTEM_ROLE_SFTP_DISABLED",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
},
"examples": {
"ERR_ACCESS_USER": {
"summary": "Insufficient access permissions",
"description": "Insufficient access permissions",
"value": {
"errors": [
{
"code": "ERR_ACCESS_USER",
"message": "Insufficient access permissions"
}
]
}
},
"ERR_PROFILE_SFTP_DISABLED": {
"summary": "SFTP is not enabled for this profile",
"description": "SFTP is not enabled for this profile",
"value": {
"errors": [
{
"code": "ERR_PROFILE_SFTP_DISABLED",
"message": "SFTP is not enabled for this profile"
}
]
}
},
"ERR_SYSTEM_ROLE_SFTP_DISABLED": {
"summary": "SFTP role is not enabled on server",
"description": "SFTP role is not enabled on server",
"value": {
"errors": [
{
"code": "ERR_SYSTEM_ROLE_SFTP_DISABLED",
"message": "SFTP role is not enabled on server"
}
]
}
}
}
}
}
},
"422": {
"description": "Unprocessable Content
Possible error codes: ERR_INVALID_PARAMETER, ERR_SSH_PUBLIC_KEY_EXISTS",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
},
"examples": {
"ERR_INVALID_PARAMETER": {
"summary": "Invalid Parameter Exception",
"description": "Invalid Parameter Exception",
"value": {
"errors": [
{
"code": "ERR_INVALID_PARAMETER",
"message": "Invalid Parameter Exception"
}
]
}
},
"ERR_SSH_PUBLIC_KEY_EXISTS": {
"summary": "Same ssh public key name exists",
"description": "Same ssh public key name exists",
"value": {
"errors": [
{
"code": "ERR_SSH_PUBLIC_KEY_EXISTS",
"message": "Same ssh public key name exists"
}
]
}
}
}
}
}
},
"490": {
"description": "Request blocked by WAF"
}
}
}
},
"/rest/userSshPublicKeys/{id}": {
"delete": {
"summary": "Delete an SSH public key",
"description": "### Description:\n Deletes the specified SSH public key belonging to the current user.\n### Precondition:\n SFTP access must be enabled for the user's profile and role.\n### Response:\n The SSH public key is deleted.\n",
"tags": [
"userSshPublicKeys"
],
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"description": "The unique identifier of the entity.",
"schema": {
"type": "integer"
}
}
],
"responses": {
"204": {
"description": "The SSH public key was successfully deleted."
},
"401": {
"description": "Unauthorized
Possible error codes: ERR_AUTH_INVALID_CSRF, ERR_AUTH_UNAUTHORIZED",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
},
"examples": {
"ERR_AUTH_INVALID_CSRF": {
"summary": "Invalid CSRF Authentication",
"description": "Invalid CSRF Authentication",
"value": {
"errors": [
{
"code": "ERR_AUTH_INVALID_CSRF",
"message": "Invalid CSRF Authentication"
}
]
}
},
"ERR_AUTH_UNAUTHORIZED": {
"summary": "Unauthorized",
"description": "Unauthorized",
"value": {
"errors": [
{
"code": "ERR_AUTH_UNAUTHORIZED",
"message": "Unauthorized"
}
]
}
}
}
}
}
},
"403": {
"description": "Forbidden
Possible error codes: ERR_ACCESS_USER, ERR_ENTITY_DELETED, ERR_PROFILE_SFTP_DISABLED, ERR_SYSTEM_ROLE_SFTP_DISABLED",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
},
"examples": {
"ERR_ACCESS_USER": {
"summary": "Insufficient access permissions",
"description": "Insufficient access permissions",
"value": {
"errors": [
{
"code": "ERR_ACCESS_USER",
"message": "Insufficient access permissions"
}
]
}
},
"ERR_ENTITY_DELETED": {
"summary": "Entity is deleted",
"description": "Entity is deleted",
"value": {
"errors": [
{
"code": "ERR_ENTITY_DELETED",
"message": "Entity is deleted"
}
]
}
},
"ERR_PROFILE_SFTP_DISABLED": {
"summary": "SFTP is not enabled for this profile",
"description": "SFTP is not enabled for this profile",
"value": {
"errors": [
{
"code": "ERR_PROFILE_SFTP_DISABLED",
"message": "SFTP is not enabled for this profile"
}
]
}
},
"ERR_SYSTEM_ROLE_SFTP_DISABLED": {
"summary": "SFTP role is not enabled on server",
"description": "SFTP role is not enabled on server",
"value": {
"errors": [
{
"code": "ERR_SYSTEM_ROLE_SFTP_DISABLED",
"message": "SFTP role is not enabled on server"
}
]
}
}
}
}
}
},
"490": {
"description": "Request blocked by WAF"
}
}
}
},
"/rest/userSshPublicKeys": {
"get": {
"summary": "List the current user's SSH public keys",
"description": "### Description:\n Returns the list of SSH public keys registered for the current user.\n### Precondition:\n SFTP access must be enabled for the user's profile and role.\n### Response:\n A list of SSH public key records is returned.\n",
"tags": [
"userSshPublicKeys"
],
"parameters": [
{
"in": "query",
"name": "limit",
"required": false,
"description": "Maximum number of SSH public keys to return.",
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "The list of SSH public keys has been successfully returned.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UserSshPublicKeyList"
}
}
}
},
"401": {
"description": "Unauthorized
Possible error codes: ERR_AUTH_INVALID_CSRF, ERR_AUTH_UNAUTHORIZED",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
},
"examples": {
"ERR_AUTH_INVALID_CSRF": {
"summary": "Invalid CSRF Authentication",
"description": "Invalid CSRF Authentication",
"value": {
"errors": [
{
"code": "ERR_AUTH_INVALID_CSRF",
"message": "Invalid CSRF Authentication"
}
]
}
},
"ERR_AUTH_UNAUTHORIZED": {
"summary": "Unauthorized",
"description": "Unauthorized",
"value": {
"errors": [
{
"code": "ERR_AUTH_UNAUTHORIZED",
"message": "Unauthorized"
}
]
}
}
}
}
}
},
"403": {
"description": "Forbidden
Possible error codes: ERR_ACCESS_USER, ERR_PROFILE_SFTP_DISABLED, ERR_SYSTEM_ROLE_SFTP_DISABLED",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
},
"examples": {
"ERR_ACCESS_USER": {
"summary": "Insufficient access permissions",
"description": "Insufficient access permissions",
"value": {
"errors": [
{
"code": "ERR_ACCESS_USER",
"message": "Insufficient access permissions"
}
]
}
},
"ERR_PROFILE_SFTP_DISABLED": {
"summary": "SFTP is not enabled for this profile",
"description": "SFTP is not enabled for this profile",
"value": {
"errors": [
{
"code": "ERR_PROFILE_SFTP_DISABLED",
"message": "SFTP is not enabled for this profile"
}
]
}
},
"ERR_SYSTEM_ROLE_SFTP_DISABLED": {
"summary": "SFTP role is not enabled on server",
"description": "SFTP role is not enabled on server",
"value": {
"errors": [
{
"code": "ERR_SYSTEM_ROLE_SFTP_DISABLED",
"message": "SFTP role is not enabled on server"
}
]
}
}
}
}
}
},
"490": {
"description": "Request blocked by WAF"
}
}
}
},
"/rest/contacts": {
"post": {
"summary": "Create a contact",
"description": "### Description:\n Creates a new contact entry for the current user, associating a display name with one or more email addresses.\n### Precondition:\n User must be authenticated.\n### Response:\n Returns the newly created contact.\n",
"tags": [
"contacts"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ContactCreate"
}
}
}
},
"responses": {
"201": {
"description": "The contact has been successfully created.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Contact"
}
}
}
},
"401": {
"description": "Unauthorized
Possible error codes: ERR_ACCESS_USER, ERR_AUTH_INVALID_CSRF, ERR_AUTH_UNAUTHORIZED",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
},
"examples": {
"ERR_ACCESS_USER": {
"summary": "Insufficient access permissions",
"description": "Insufficient access permissions",
"value": {
"errors": [
{
"code": "ERR_ACCESS_USER",
"message": "Insufficient access permissions"
}
]
}
},
"ERR_AUTH_INVALID_CSRF": {
"summary": "Invalid CSRF Authentication",
"description": "Invalid CSRF Authentication",
"value": {
"errors": [
{
"code": "ERR_AUTH_INVALID_CSRF",
"message": "Invalid CSRF Authentication"
}
]
}
},
"ERR_AUTH_UNAUTHORIZED": {
"summary": "Unauthorized",
"description": "Unauthorized",
"value": {
"errors": [
{
"code": "ERR_AUTH_UNAUTHORIZED",
"message": "Unauthorized"
}
]
}
}
}
}
}
},
"409": {
"description": "Conflict
Possible error codes: ERR_ENTITY_EXISTS",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
},
"examples": {
"ERR_ENTITY_EXISTS": {
"summary": "Entity exists",
"description": "Entity exists",
"value": {
"errors": [
{
"code": "ERR_ENTITY_EXISTS",
"message": "Entity exists"
}
]
}
}
}
}
}
},
"422": {
"description": "Unprocessable Content
Possible error codes: ERR_INVALID_PARAMETER",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
},
"examples": {
"ERR_INVALID_PARAMETER": {
"summary": "Invalid Parameter Exception",
"description": "Invalid Parameter Exception",
"value": {
"errors": [
{
"code": "ERR_INVALID_PARAMETER",
"message": "Invalid Parameter Exception"
}
]
}
}
}
}
}
},
"490": {
"description": "Request blocked by WAF"
}
}
},
"get": {
"summary": "List contacts",
"description": "### Description:\n Returns a paginated list of the current user's contacts, with optional name filtering and sort order.\n### Precondition:\n User must be authenticated.\n### Response:\n Returns the list of contacts matching the specified filters.\n",
"tags": [
"contacts"
],
"parameters": [
{
"in": "query",
"name": "name",
"required": false,
"description": "Filter contacts by exact name match.",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "name:contains",
"required": false,
"description": "Filter contacts whose name contains the specified string.",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "orderBy",
"required": false,
"description": "Sort order for the results. Default is `name:asc`.
Allowed values: `id:asc`, `id:desc`, `name:asc`, `name:desc`, `lastContactDate:asc`, `lastContactDate:desc`.",
"schema": {
"type": "string",
"enum": [
"id:asc",
"id:desc",
"name:asc",
"name:desc",
"lastContactDate:asc",
"lastContactDate:desc"
]
}
},
{
"in": "query",
"name": "limit",
"required": false,
"description": "Maximum number of contacts to return.",
"schema": {
"type": "integer"
}
},
{
"in": "query",
"name": "offset",
"required": false,
"description": "Number of contacts to skip before returning results, for pagination.",
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "The contacts list has been successfully returned.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ContactList"
}
}
}
},
"400": {
"description": "Bad Request
Possible error codes: ERR_REQUEST_INVALID_FILTER",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
},
"examples": {
"ERR_REQUEST_INVALID_FILTER": {
"summary": "Filter validation failed",
"description": "Filter validation failed",
"value": {
"errors": [
{
"code": "ERR_REQUEST_INVALID_FILTER",
"message": "Filter validation failed"
}
]
}
}
}
}
}
},
"401": {
"description": "Unauthorized
Possible error codes: ERR_ACCESS_USER, ERR_AUTH_INVALID_CSRF, ERR_AUTH_UNAUTHORIZED",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
},
"examples": {
"ERR_ACCESS_USER": {
"summary": "Insufficient access permissions",
"description": "Insufficient access permissions",
"value": {
"errors": [
{
"code": "ERR_ACCESS_USER",
"message": "Insufficient access permissions"
}
]
}
},
"ERR_AUTH_INVALID_CSRF": {
"summary": "Invalid CSRF Authentication",
"description": "Invalid CSRF Authentication",
"value": {
"errors": [
{
"code": "ERR_AUTH_INVALID_CSRF",
"message": "Invalid CSRF Authentication"
}
]
}
},
"ERR_AUTH_UNAUTHORIZED": {
"summary": "Unauthorized",
"description": "Unauthorized",
"value": {
"errors": [
{
"code": "ERR_AUTH_UNAUTHORIZED",
"message": "Unauthorized"
}
]
}
}
}
}
}
},
"490": {
"description": "Request blocked by WAF"
}
}
}
},
"/rest/contacts/{id}": {
"put": {
"summary": "Update a contact",
"description": "### Description:\n Updates the display name and associated email addresses of the specified contact.\n### Precondition:\n User must be authenticated and must own the contact.\n### Response:\n The contact has been updated.\n",
"tags": [
"contacts"
],
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"description": "The unique identifier of the entity.",
"schema": {
"type": "integer"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ContactCreate"
}
}
}
},
"responses": {
"200": {
"description": "The contact has been successfully updated."
},
"401": {
"description": "Unauthorized
Possible error codes: ERR_AUTH_INVALID_CSRF, ERR_AUTH_UNAUTHORIZED",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
},
"examples": {
"ERR_AUTH_INVALID_CSRF": {
"summary": "Invalid CSRF Authentication",
"description": "Invalid CSRF Authentication",
"value": {
"errors": [
{
"code": "ERR_AUTH_INVALID_CSRF",
"message": "Invalid CSRF Authentication"
}
]
}
},
"ERR_AUTH_UNAUTHORIZED": {
"summary": "Unauthorized",
"description": "Unauthorized",
"value": {
"errors": [
{
"code": "ERR_AUTH_UNAUTHORIZED",
"message": "Unauthorized"
}
]
}
}
}
}
}
},
"403": {
"description": "Forbidden
Possible error codes: ERR_ACCESS_USER",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
},
"examples": {
"ERR_ACCESS_USER": {
"summary": "Insufficient access permissions",
"description": "Insufficient access permissions",
"value": {
"errors": [
{
"code": "ERR_ACCESS_USER",
"message": "Insufficient access permissions"
}
]
}
}
}
}
}
},
"409": {
"description": "Conflict
Possible error codes: ERR_ENTITY_EXISTS",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
},
"examples": {
"ERR_ENTITY_EXISTS": {
"summary": "Entity exists",
"description": "Entity exists",
"value": {
"errors": [
{
"code": "ERR_ENTITY_EXISTS",
"message": "Entity exists"
}
]
}
}
}
}
}
},
"422": {
"description": "Unprocessable Content
Possible error codes: ERR_INVALID_PARAMETER",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
},
"examples": {
"ERR_INVALID_PARAMETER": {
"summary": "Invalid Parameter Exception",
"description": "Invalid Parameter Exception",
"value": {
"errors": [
{
"code": "ERR_INVALID_PARAMETER",
"message": "Invalid Parameter Exception"
}
]
}
}
}
}
}
},
"490": {
"description": "Request blocked by WAF"
}
}
},
"get": {
"summary": "Get a contact",
"description": "### Description:\n Returns the details of the specified contact, including its display name and associated email addresses.\n### Precondition:\n User must be authenticated and must own the contact.\n### Response:\n Returns the contact details.\n",
"tags": [
"contacts"
],
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"description": "The unique identifier of the entity.",
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "The contact has been successfully returned.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Contact"
}
}
}
},
"401": {
"description": "Unauthorized
Possible error codes: ERR_AUTH_INVALID_CSRF, ERR_AUTH_UNAUTHORIZED",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
},
"examples": {
"ERR_AUTH_INVALID_CSRF": {
"summary": "Invalid CSRF Authentication",
"description": "Invalid CSRF Authentication",
"value": {
"errors": [
{
"code": "ERR_AUTH_INVALID_CSRF",
"message": "Invalid CSRF Authentication"
}
]
}
},
"ERR_AUTH_UNAUTHORIZED": {
"summary": "Unauthorized",
"description": "Unauthorized",
"value": {
"errors": [
{
"code": "ERR_AUTH_UNAUTHORIZED",
"message": "Unauthorized"
}
]
}
}
}
}
}
},
"403": {
"description": "Forbidden
Possible error codes: ERR_ACCESS_USER",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
},
"examples": {
"ERR_ACCESS_USER": {
"summary": "Insufficient access permissions",
"description": "Insufficient access permissions",
"value": {
"errors": [
{
"code": "ERR_ACCESS_USER",
"message": "Insufficient access permissions"
}
]
}
}
}
}
}
},
"490": {
"description": "Request blocked by WAF"
}
}
},
"delete": {
"summary": "Delete a contact",
"description": "### Description:\n Permanently removes the specified contact from the current user's contact list.\n### Precondition:\n User must be authenticated and must own the contact.\n### Response:\n The contact has been deleted.\n",
"tags": [
"contacts"
],
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"description": "The unique identifier of the entity.",
"schema": {
"type": "integer"
}
}
],
"responses": {
"204": {
"description": "The contact has been successfully deleted."
},
"401": {
"description": "Unauthorized
Possible error codes: ERR_AUTH_INVALID_CSRF, ERR_AUTH_UNAUTHORIZED",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
},
"examples": {
"ERR_AUTH_INVALID_CSRF": {
"summary": "Invalid CSRF Authentication",
"description": "Invalid CSRF Authentication",
"value": {
"errors": [
{
"code": "ERR_AUTH_INVALID_CSRF",
"message": "Invalid CSRF Authentication"
}
]
}
},
"ERR_AUTH_UNAUTHORIZED": {
"summary": "Unauthorized",
"description": "Unauthorized",
"value": {
"errors": [
{
"code": "ERR_AUTH_UNAUTHORIZED",
"message": "Unauthorized"
}
]
}
}
}
}
}
},
"403": {
"description": "Forbidden
Possible error codes: ERR_ACCESS_USER",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
},
"examples": {
"ERR_ACCESS_USER": {
"summary": "Insufficient access permissions",
"description": "Insufficient access permissions",
"value": {
"errors": [
{
"code": "ERR_ACCESS_USER",
"message": "Insufficient access permissions"
}
]
}
}
}
}
}
},
"490": {
"description": "Request blocked by WAF"
}
}
}
},
"/rest/groups": {
"post": {
"summary": "Create a group entry",
"description": "### Description:\n Creates a new Kiteworks group of users.\n### Precondition:\n User must be authenticated.\n### Response:\n Returns the newly created group.\n",
"tags": [
"groups"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GroupCreate"
}
}
}
},
"responses": {
"201": {
"description": "The group has been successfully created.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Contact"
}
}
}
},
"401": {
"description": "Unauthorized
Possible error codes: ERR_ACCESS_USER, ERR_AUTH_INVALID_CSRF, ERR_AUTH_UNAUTHORIZED",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
},
"examples": {
"ERR_ACCESS_USER": {
"summary": "Insufficient access permissions",
"description": "Insufficient access permissions",
"value": {
"errors": [
{
"code": "ERR_ACCESS_USER",
"message": "Insufficient access permissions"
}
]
}
},
"ERR_AUTH_INVALID_CSRF": {
"summary": "Invalid CSRF Authentication",
"description": "Invalid CSRF Authentication",
"value": {
"errors": [
{
"code": "ERR_AUTH_INVALID_CSRF",
"message": "Invalid CSRF Authentication"
}
]
}
},
"ERR_AUTH_UNAUTHORIZED": {
"summary": "Unauthorized",
"description": "Unauthorized",
"value": {
"errors": [
{
"code": "ERR_AUTH_UNAUTHORIZED",
"message": "Unauthorized"
}
]
}
}
}
}
}
},
"409": {
"description": "Conflict
Possible error codes: ERR_ENTITY_EXISTS",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
},
"examples": {
"ERR_ENTITY_EXISTS": {
"summary": "Entity exists",
"description": "Entity exists",
"value": {
"errors": [
{
"code": "ERR_ENTITY_EXISTS",
"message": "Entity exists"
}
]
}
}
}
}
}
},
"422": {
"description": "Unprocessable Content
Possible error codes: ERR_INVALID_PARAMETER",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
},
"examples": {
"ERR_INVALID_PARAMETER": {
"summary": "Invalid Parameter Exception",
"description": "Invalid Parameter Exception",
"value": {
"errors": [
{
"code": "ERR_INVALID_PARAMETER",
"message": "Invalid Parameter Exception"
}
]
}
}
}
}
}
},
"490": {
"description": "Request blocked by WAF"
}
}
},
"get": {
"summary": "List Kiteworks groups",
"description": "### Description:\n Returns the list of Kiteworks groups for the current user, including the email address of each member in the group.\n### Precondition:\n User must be authenticated.\n### Response:\n Returns the list of groups.\n",
"tags": [
"groups"
],
"parameters": [
{
"in": "query",
"name": "name",
"required": false,
"description": "Filter results by the exact group name.",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "name:contains",
"required": false,
"description": "Filter results to groups whose names contain the specified characters.",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "orderBy",
"required": false,
"description": "Sort order for the results. Default is `name:asc`.
Allowed values: `id:asc`, `id:desc`, `name:asc`, `name:desc`.",
"schema": {
"type": "string",
"enum": [
"id:asc",
"id:desc",
"name:asc",
"name:desc"
]
}
},
{
"in": "query",
"name": "limit",
"required": false,
"description": "Maximum number of groups to return.",
"schema": {
"type": "integer"
}
},
{
"in": "query",
"name": "offset",
"required": false,
"description": "Number of groups to skip before returning results, for pagination.",
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "The groups list has been successfully returned.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ContactList"
}
}
}
},
"400": {
"description": "Bad Request
Possible error codes: ERR_REQUEST_INVALID_FILTER",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
},
"examples": {
"ERR_REQUEST_INVALID_FILTER": {
"summary": "Filter validation failed",
"description": "Filter validation failed",
"value": {
"errors": [
{
"code": "ERR_REQUEST_INVALID_FILTER",
"message": "Filter validation failed"
}
]
}
}
}
}
}
},
"401": {
"description": "Unauthorized
Possible error codes: ERR_ACCESS_USER, ERR_AUTH_INVALID_CSRF, ERR_AUTH_UNAUTHORIZED",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
},
"examples": {
"ERR_ACCESS_USER": {
"summary": "Insufficient access permissions",
"description": "Insufficient access permissions",
"value": {
"errors": [
{
"code": "ERR_ACCESS_USER",
"message": "Insufficient access permissions"
}
]
}
},
"ERR_AUTH_INVALID_CSRF": {
"summary": "Invalid CSRF Authentication",
"description": "Invalid CSRF Authentication",
"value": {
"errors": [
{
"code": "ERR_AUTH_INVALID_CSRF",
"message": "Invalid CSRF Authentication"
}
]
}
},
"ERR_AUTH_UNAUTHORIZED": {
"summary": "Unauthorized",
"description": "Unauthorized",
"value": {
"errors": [
{
"code": "ERR_AUTH_UNAUTHORIZED",
"message": "Unauthorized"
}
]
}
}
}
}
}
},
"490": {
"description": "Request blocked by WAF"
}
}
}
},
"/rest/groups/{id}": {
"put": {
"summary": "Update a group entry",
"description": "### Description:\n Updates the specified group's name and members.\n### Precondition:\n User must be the owner of the group.\n### Response:\n The group is updated.\n",
"tags": [
"groups"
],
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"description": "The unique identifier of the entity.",
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "The group has been successfully updated."
},
"401": {
"description": "Unauthorized
Possible error codes: ERR_AUTH_INVALID_CSRF, ERR_AUTH_UNAUTHORIZED",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
},
"examples": {
"ERR_AUTH_INVALID_CSRF": {
"summary": "Invalid CSRF Authentication",
"description": "Invalid CSRF Authentication",
"value": {
"errors": [
{
"code": "ERR_AUTH_INVALID_CSRF",
"message": "Invalid CSRF Authentication"
}
]
}
},
"ERR_AUTH_UNAUTHORIZED": {
"summary": "Unauthorized",
"description": "Unauthorized",
"value": {
"errors": [
{
"code": "ERR_AUTH_UNAUTHORIZED",
"message": "Unauthorized"
}
]
}
}
}
}
}
},
"403": {
"description": "Forbidden
Possible error codes: ERR_ACCESS_USER",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
},
"examples": {
"ERR_ACCESS_USER": {
"summary": "Insufficient access permissions",
"description": "Insufficient access permissions",
"value": {
"errors": [
{
"code": "ERR_ACCESS_USER",
"message": "Insufficient access permissions"
}
]
}
}
}
}
}
},
"409": {
"description": "Conflict
Possible error codes: ERR_ENTITY_EXISTS",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
},
"examples": {
"ERR_ENTITY_EXISTS": {
"summary": "Entity exists",
"description": "Entity exists",
"value": {
"errors": [
{
"code": "ERR_ENTITY_EXISTS",
"message": "Entity exists"
}
]
}
}
}
}
}
},
"422": {
"description": "Unprocessable Content
Possible error codes: ERR_INVALID_PARAMETER",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
},
"examples": {
"ERR_INVALID_PARAMETER": {
"summary": "Invalid Parameter Exception",
"description": "Invalid Parameter Exception",
"value": {
"errors": [
{
"code": "ERR_INVALID_PARAMETER",
"message": "Invalid Parameter Exception"
}
]
}
}
}
}
}
},
"490": {
"description": "Request blocked by WAF"
}
}
},
"get": {
"summary": "Return users for the specified group",
"description": "### Description:\n Returns the list of users for the specified group.\n### Precondition:\n User must be authenticated.\n### Response:\n Returns the group details including its members.\n",
"tags": [
"groups"
],
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"description": "The unique identifier of the entity.",
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "The group has been successfully returned.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Contact"
}
}
}
},
"401": {
"description": "Unauthorized
Possible error codes: ERR_AUTH_INVALID_CSRF, ERR_AUTH_UNAUTHORIZED",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
},
"examples": {
"ERR_AUTH_INVALID_CSRF": {
"summary": "Invalid CSRF Authentication",
"description": "Invalid CSRF Authentication",
"value": {
"errors": [
{
"code": "ERR_AUTH_INVALID_CSRF",
"message": "Invalid CSRF Authentication"
}
]
}
},
"ERR_AUTH_UNAUTHORIZED": {
"summary": "Unauthorized",
"description": "Unauthorized",
"value": {
"errors": [
{
"code": "ERR_AUTH_UNAUTHORIZED",
"message": "Unauthorized"
}
]
}
}
}
}
}
},
"403": {
"description": "Forbidden
Possible error codes: ERR_ACCESS_USER",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
},
"examples": {
"ERR_ACCESS_USER": {
"summary": "Insufficient access permissions",
"description": "Insufficient access permissions",
"value": {
"errors": [
{
"code": "ERR_ACCESS_USER",
"message": "Insufficient access permissions"
}
]
}
}
}
}
}
},
"490": {
"description": "Request blocked by WAF"
}
}
},
"delete": {
"summary": "Delete a group entry",
"description": "### Description:\n Deletes the specified group.\n### Precondition:\n User must be the owner of the group.\n### Response:\n The group is deleted.\n",
"tags": [
"groups"
],
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"description": "The unique identifier of the entity.",
"schema": {
"type": "integer"
}
}
],
"responses": {
"204": {
"description": "The group has been successfully deleted."
},
"401": {
"description": "Unauthorized
Possible error codes: ERR_AUTH_INVALID_CSRF, ERR_AUTH_UNAUTHORIZED",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
},
"examples": {
"ERR_AUTH_INVALID_CSRF": {
"summary": "Invalid CSRF Authentication",
"description": "Invalid CSRF Authentication",
"value": {
"errors": [
{
"code": "ERR_AUTH_INVALID_CSRF",
"message": "Invalid CSRF Authentication"
}
]
}
},
"ERR_AUTH_UNAUTHORIZED": {
"summary": "Unauthorized",
"description": "Unauthorized",
"value": {
"errors": [
{
"code": "ERR_AUTH_UNAUTHORIZED",
"message": "Unauthorized"
}
]
}
}
}
}
}
},
"403": {
"description": "Forbidden
Possible error codes: ERR_ACCESS_USER",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
},
"examples": {
"ERR_ACCESS_USER": {
"summary": "Insufficient access permissions",
"description": "Insufficient access permissions",
"value": {
"errors": [
{
"code": "ERR_ACCESS_USER",
"message": "Insufficient access permissions"
}
]
}
}
}
}
}
},
"490": {
"description": "Request blocked by WAF"
}
}
}
},
"/rest/clients/action/eventLog": {
"post": {
"summary": "Submit client event logs",
"description": "### Description:\n Submits one or more event log entries from the client for recording on the server.\n### Precondition:\n User must be authenticated.\n### Response:\n Returns the created event log entries.\n",
"tags": [
"clientEventLogs"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BulkClientEventLogsPostRequest"
}
}
}
},
"responses": {
"201": {
"description": "The event logs have been successfully submitted.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ClientCustomEventLog"
}
}
}
},
"401": {
"description": "Unauthorized
Possible error codes: ERR_AUTH_INVALID_CSRF, ERR_AUTH_UNAUTHORIZED",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
},
"examples": {
"ERR_AUTH_INVALID_CSRF": {
"summary": "Invalid CSRF Authentication",
"description": "Invalid CSRF Authentication",
"value": {
"errors": [
{
"code": "ERR_AUTH_INVALID_CSRF",
"message": "Invalid CSRF Authentication"
}
]
}
},
"ERR_AUTH_UNAUTHORIZED": {
"summary": "Unauthorized",
"description": "Unauthorized",
"value": {
"errors": [
{
"code": "ERR_AUTH_UNAUTHORIZED",
"message": "Unauthorized"
}
]
}
}
}
}
}
},
"403": {
"description": "Forbidden
Possible error codes: ERR_ACCESS_USER",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
},
"examples": {
"ERR_ACCESS_USER": {
"summary": "Insufficient access permissions",
"description": "Insufficient access permissions",
"value": {
"errors": [
{
"code": "ERR_ACCESS_USER",
"message": "Insufficient access permissions"
}
]
}
}
}
}
}
},
"422": {
"description": "Unprocessable Content
Possible error codes: ERR_INVALID_PARAMETER",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
},
"examples": {
"ERR_INVALID_PARAMETER": {
"summary": "Invalid Parameter Exception",
"description": "Invalid Parameter Exception",
"value": {
"errors": [
{
"code": "ERR_INVALID_PARAMETER",
"message": "Invalid Parameter Exception"
}
]
}
}
}
}
}
},
"490": {
"description": "Request blocked by WAF"
}
}
}
},
"/rest/query": {
"get": {
"summary": "Perform a search query",
"description": "### Description:\n Searches for files, folders, or emails based on the provided query parameters.\n### Precondition:\n The user must be authenticated.\n### Response:\n Returns a list of matching files, folders, or emails.\n### Sorting:\n Sorting can be applied using two query parameters: `orderBy` for the field name,\n and `orderType` for the sort order, which can be either `asc` or `desc`.\n### Sorting options:\n | FIELD_NAME | Description |\n |------------|-------------|\n | score | The search relevance score |\n | name | The name of the folder or file |\n | created | The creation datetime of the folder or file |\n | modified | The last modified datetime of the folder or file |\n",
"tags": [
"search"
],
"parameters": [
{
"in": "query",
"name": "limit",
"required": false,
"description": "Range limit.",
"schema": {
"type": "integer",
"minimum": 1
}
},
{
"in": "query",
"name": "offset",
"required": false,
"description": "Range offset.",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"in": "query",
"name": "includeContent",
"required": true,
"description": "Indicates whether it is a full-text search or a database search.",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "searchType",
"required": true,
"explode": true,
"style": "form",
"description": "Comma-separated list of object types to search.
`f` \u2013 Files.
`d` \u2013 Folders.
`e` \u2013 Emails.",
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
{
"in": "query",
"name": "query",
"required": false,
"description": "Search query string.",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "objectId",
"required": false,
"description": "Search within a specific folder ID.",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "created",
"required": false,
"description": "Exact creation date.",
"schema": {
"type": "string",
"format": "date"
}
},
{
"in": "query",
"name": "created:gt",
"required": false,
"description": "Created after the specified date.",
"schema": {
"type": "string",
"format": "date"
}
},
{
"in": "query",
"name": "created:gte",
"required": false,
"description": "Created on or after the specified date.",
"schema": {
"type": "string",
"format": "date"
}
},
{
"in": "query",
"name": "created:lt",
"required": false,
"description": "Created before the specified date.",
"schema": {
"type": "string",
"format": "date"
}
},
{
"in": "query",
"name": "created:lte",
"required": false,
"description": "Created on or before the specified date.",
"schema": {
"type": "string",
"format": "date"
}
},
{
"in": "query",
"name": "modified",
"required": false,
"description": "Exact modified date.",
"schema": {
"type": "string",
"format": "date"
}
},
{
"in": "query",
"name": "modified:gt",
"required": false,
"description": "Modified after the specified date.",
"schema": {
"type": "string",
"format": "date"
}
},
{
"in": "query",
"name": "modified:gte",
"required": false,
"description": "Modified on or after the specified date.",
"schema": {
"type": "string",
"format": "date"
}
},
{
"in": "query",
"name": "modified:lt",
"required": false,
"description": "Modified before the specified date.",
"schema": {
"type": "string",
"format": "date"
}
},
{
"in": "query",
"name": "modified:lte",
"required": false,
"description": "Modified on or before the specified date.",
"schema": {
"type": "string",
"format": "date"
}
},
{
"in": "query",
"name": "fileSize",
"required": false,
"description": "Exact file size in bytes.",
"schema": {
"type": "integer"
}
},
{
"in": "query",
"name": "fileSize:gt",
"required": false,
"description": "File size greater than the specified value.",
"schema": {
"type": "integer"
}
},
{
"in": "query",
"name": "fileSize:gte",
"required": false,
"description": "File size greater than or equal to the specified value.",
"schema": {
"type": "integer"
}
},
{
"in": "query",
"name": "fileSize:lt",
"required": false,
"description": "File size less than the specified value.",
"schema": {
"type": "integer"
}
},
{
"in": "query",
"name": "fileSize:lte",
"required": false,
"description": "File size less than or equal to the specified value.",
"schema": {
"type": "integer"
}
},
{
"in": "query",
"name": "user",
"required": false,
"description": "User email of the folder creator.",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "fileType",
"required": false,
"explode": true,
"style": "form",
"description": "List of comma-separated file types to filter search results.",
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
{
"in": "query",
"name": "flsOnly",
"required": false,
"description": "If true, only includes files shared with the user.",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "sharedMailboxId",
"required": false,
"description": "Shared mailbox ID.",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "orderBy",
"required": false,
"description": "Field to sort results by.
Allowed values: `score`, `name`, `created`, `modified`.",
"schema": {
"type": "string",
"enum": [
"score",
"name",
"created",
"modified"
]
}
},
{
"in": "query",
"name": "orderType",
"required": false,
"description": "Sort direction for the results.
`asc` \u2013 Ascending order.
`desc` \u2013 Descending order.",
"schema": {
"type": "string",
"enum": [
"asc",
"desc"
]
}
},
{
"in": "query",
"name": "nameOnly",
"required": false,
"description": "If true, searches only for file/folder names.",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "subject",
"required": false,
"description": "Email subject filter.",
"schema": {
"type": "string",
"maxLength": 998
}
},
{
"in": "query",
"name": "senderId",
"required": false,
"description": "Sender ID.",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "recipientId",
"required": false,
"description": "Recipient ID.",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "fileName",
"required": false,
"description": "File name filter.",
"schema": {
"type": "string",
"maxLength": 255
}
},
{
"in": "query",
"name": "folderName",
"required": false,
"description": "Folder name filter.",
"schema": {
"type": "string",
"maxLength": 255
}
},
{
"in": "query",
"name": "fileContent",
"required": false,
"description": "Search within file content.",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "spellCheck",
"required": false,
"description": "If true, provides spelling suggestions for the search query.",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "bucket",
"required": false,
"description": "Filter email search results by mailbox folder.
`inbox` \u2013 Search in the inbox.
`sent` \u2013 Search in sent items.",
"schema": {
"type": "string",
"enum": [
"inbox",
"sent"
]
}
},
{
"in": "query",
"name": "path",
"required": false,
"description": "Search within a specific folder path.",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "tracking_id",
"required": false,
"description": "Filter files by their tracking ID (UUID).",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "query",
"name": "extensions",
"required": false,
"explode": true,
"style": "form",
"description": "Comma-separated file extensions to filter (e.g., \"pdf,form\" or \".pdf,.form\").",
"schema": {
"type": "array",
"items": {
"type": "string",
"minLength": 1
}
}
}
],
"responses": {
"200": {
"description": "Search completed successfully.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SearchResult"
}
}
}
},
"401": {
"description": "Unauthorized
Possible error codes: ERR_AUTH_INVALID_CSRF, ERR_AUTH_UNAUTHORIZED",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
},
"examples": {
"ERR_AUTH_INVALID_CSRF": {
"summary": "Invalid CSRF Authentication",
"description": "Invalid CSRF Authentication",
"value": {
"errors": [
{
"code": "ERR_AUTH_INVALID_CSRF",
"message": "Invalid CSRF Authentication"
}
]
}
},
"ERR_AUTH_UNAUTHORIZED": {
"summary": "Unauthorized",
"description": "Unauthorized",
"value": {
"errors": [
{
"code": "ERR_AUTH_UNAUTHORIZED",
"message": "Unauthorized"
}
]
}
}
}
}
}
},
"403": {
"description": "Forbidden
Possible error codes: ERR_PROFILE_COLLABORATION_DISABLED",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
},
"examples": {
"ERR_PROFILE_COLLABORATION_DISABLED": {
"summary": "User's profile has no collaboration access",
"description": "User's profile has no collaboration access",
"value": {
"errors": [
{
"code": "ERR_PROFILE_COLLABORATION_DISABLED",
"message": "User's profile has no collaboration access"
}
]
}
}
}
}
}
},
"422": {
"description": "Unprocessable Content
Possible error codes: ERR_INVALID_PARAMETER",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
},
"examples": {
"ERR_INVALID_PARAMETER": {
"summary": "Invalid Parameter Exception",
"description": "Invalid Parameter Exception",
"value": {
"errors": [
{
"code": "ERR_INVALID_PARAMETER",
"message": "Invalid Parameter Exception"
}
]
}
}
}
}
}
},
"490": {
"description": "Request blocked by WAF"
}
}
}
},
"/rest/scim/users": {
"post": {
"summary": "Create a user",
"description": "### Description:\n Creates a new SCIM user with the specified attributes.\n### Precondition:\n The request must be authenticated using a valid SCIM token.\n### Response:\n The newly created user is returned.\n",
"tags": [
"scim"
],
"parameters": [
{
"in": "query",
"name": "attributes",
"required": false,
"explode": true,
"style": "form",
"description": "Comma-separated list of attribute names to include in the response.",
"schema": {
"type": "array",
"items": {
"type": "string",
"enum": [
"id",
"meta",
"userName",
"displayName",
"userType",
"preferredLanguage",
"active",
"emails",
"phoneNumbers",
"photos",
"roles",
"meta.resourceType",
"meta.created",
"meta.location",
"urn:ietf:params:scim:schemas:core:2.0:User:id",
"urn:ietf:params:scim:schemas:core:2.0:User:meta",
"urn:ietf:params:scim:schemas:core:2.0:User:userName",
"urn:ietf:params:scim:schemas:core:2.0:User:displayName",
"urn:ietf:params:scim:schemas:core:2.0:User:userType",
"urn:ietf:params:scim:schemas:core:2.0:User:preferredLanguage",
"urn:ietf:params:scim:schemas:core:2.0:User:active",
"urn:ietf:params:scim:schemas:core:2.0:User:emails",
"urn:ietf:params:scim:schemas:core:2.0:User:phoneNumbers",
"urn:ietf:params:scim:schemas:core:2.0:User:photos",
"urn:ietf:params:scim:schemas:core:2.0:User:roles",
"urn:ietf:params:scim:schemas:core:2.0:User:meta.resourceType",
"urn:ietf:params:scim:schemas:core:2.0:User:meta.created",
"urn:ietf:params:scim:schemas:core:2.0:User:meta.location"
]
}
}
},
{
"in": "query",
"name": "excludedAttributes",
"required": false,
"explode": true,
"style": "form",
"description": "Comma-separated list of attribute names to exclude from the response.",
"schema": {
"type": "array",
"items": {
"type": "string",
"enum": [
"meta",
"userName",
"displayName",
"userType",
"preferredLanguage",
"active",
"emails",
"phoneNumbers",
"photos",
"roles",
"meta.resourceType",
"meta.created",
"meta.location",
"urn:ietf:params:scim:schemas:core:2.0:User:meta",
"urn:ietf:params:scim:schemas:core:2.0:User:userName",
"urn:ietf:params:scim:schemas:core:2.0:User:displayName",
"urn:ietf:params:scim:schemas:core:2.0:User:userType",
"urn:ietf:params:scim:schemas:core:2.0:User:preferredLanguage",
"urn:ietf:params:scim:schemas:core:2.0:User:active",
"urn:ietf:params:scim:schemas:core:2.0:User:emails",
"urn:ietf:params:scim:schemas:core:2.0:User:phoneNumbers",
"urn:ietf:params:scim:schemas:core:2.0:User:photos",
"urn:ietf:params:scim:schemas:core:2.0:User:roles",
"urn:ietf:params:scim:schemas:core:2.0:User:meta.resourceType",
"urn:ietf:params:scim:schemas:core:2.0:User:meta.created",
"urn:ietf:params:scim:schemas:core:2.0:User:meta.location"
]
}
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ScimUsersPostRequest"
}
}
}
},
"responses": {
"201": {
"description": "The user is created successfully.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ScimUser"
}
}
}
},
"400": {
"description": "Bad request."
},
"401": {
"description": "Unauthorized."
},
"403": {
"description": "Forbidden."
},
"409": {
"description": "Conflict."
},
"490": {
"description": "Request blocked by WAF"
}
}
},
"get": {
"summary": "Retrieve users",
"description": "### Description:\n Returns a paginated list of SCIM users matching the specified filter criteria.\n### Precondition:\n The request must be authenticated using a valid SCIM token.\n### Response:\n A list of SCIM users is returned.\n",
"tags": [
"scim"
],
"parameters": [
{
"in": "query",
"name": "attributes",
"required": false,
"explode": true,
"style": "form",
"description": "Comma-separated list of attribute names to include in the response.",
"schema": {
"type": "array",
"items": {
"type": "string",
"enum": [
"id",
"meta",
"userName",
"displayName",
"userType",
"preferredLanguage",
"active",
"emails",
"phoneNumbers",
"photos",
"roles",
"meta.resourceType",
"meta.created",
"meta.location",
"urn:ietf:params:scim:schemas:core:2.0:User:id",
"urn:ietf:params:scim:schemas:core:2.0:User:meta",
"urn:ietf:params:scim:schemas:core:2.0:User:userName",
"urn:ietf:params:scim:schemas:core:2.0:User:displayName",
"urn:ietf:params:scim:schemas:core:2.0:User:userType",
"urn:ietf:params:scim:schemas:core:2.0:User:preferredLanguage",
"urn:ietf:params:scim:schemas:core:2.0:User:active",
"urn:ietf:params:scim:schemas:core:2.0:User:emails",
"urn:ietf:params:scim:schemas:core:2.0:User:phoneNumbers",
"urn:ietf:params:scim:schemas:core:2.0:User:photos",
"urn:ietf:params:scim:schemas:core:2.0:User:roles",
"urn:ietf:params:scim:schemas:core:2.0:User:meta.resourceType",
"urn:ietf:params:scim:schemas:core:2.0:User:meta.created",
"urn:ietf:params:scim:schemas:core:2.0:User:meta.location"
]
}
}
},
{
"in": "query",
"name": "excludedAttributes",
"required": false,
"explode": true,
"style": "form",
"description": "Comma-separated list of attribute names to exclude from the response.",
"schema": {
"type": "array",
"items": {
"type": "string",
"enum": [
"meta",
"userName",
"displayName",
"userType",
"preferredLanguage",
"active",
"emails",
"phoneNumbers",
"photos",
"roles",
"meta.resourceType",
"meta.created",
"meta.location",
"urn:ietf:params:scim:schemas:core:2.0:User:meta",
"urn:ietf:params:scim:schemas:core:2.0:User:userName",
"urn:ietf:params:scim:schemas:core:2.0:User:displayName",
"urn:ietf:params:scim:schemas:core:2.0:User:userType",
"urn:ietf:params:scim:schemas:core:2.0:User:preferredLanguage",
"urn:ietf:params:scim:schemas:core:2.0:User:active",
"urn:ietf:params:scim:schemas:core:2.0:User:emails",
"urn:ietf:params:scim:schemas:core:2.0:User:phoneNumbers",
"urn:ietf:params:scim:schemas:core:2.0:User:photos",
"urn:ietf:params:scim:schemas:core:2.0:User:roles",
"urn:ietf:params:scim:schemas:core:2.0:User:meta.resourceType",
"urn:ietf:params:scim:schemas:core:2.0:User:meta.created",
"urn:ietf:params:scim:schemas:core:2.0:User:meta.location"
]
}
}
},
{
"in": "query",
"name": "filter",
"required": false,
"description": "SCIM filter expression to narrow the list of returned users (e.g., `userName eq \"user@example.com\"`).",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "sortBy",
"required": false,
"description": "Attribute name to sort results by.",
"schema": {
"type": "string",
"enum": [
"meta.created",
"meta.location",
"userName",
"displayName",
"userType",
"preferredLanguage",
"emails",
"emails.value",
"phoneNumbers",
"phoneNumbers.value",
"roles",
"roles.value",
"active",
"urn:ietf:params:scim:schemas:core:2.0:User:meta.created",
"urn:ietf:params:scim:schemas:core:2.0:User:meta.location",
"urn:ietf:params:scim:schemas:core:2.0:User:userName",
"urn:ietf:params:scim:schemas:core:2.0:User:displayName",
"urn:ietf:params:scim:schemas:core:2.0:User:userType",
"urn:ietf:params:scim:schemas:core:2.0:User:preferredLanguage",
"urn:ietf:params:scim:schemas:core:2.0:User:emails",
"urn:ietf:params:scim:schemas:core:2.0:User:emails.value",
"urn:ietf:params:scim:schemas:core:2.0:User:phoneNumbers",
"urn:ietf:params:scim:schemas:core:2.0:User:phoneNumbers.value",
"urn:ietf:params:scim:schemas:core:2.0:User:roles",
"urn:ietf:params:scim:schemas:core:2.0:User:roles.value",
"urn:ietf:params:scim:schemas:core:2.0:User:active"
]
}
},
{
"in": "query",
"name": "sortOrder",
"required": false,
"description": "Sort direction for the results.
`ascending` \u2013 Sort in ascending order.
`descending` \u2013 Sort in descending order.",
"schema": {
"type": "string",
"enum": [
"ascending",
"descending"
]
}
},
{
"in": "query",
"name": "startIndex",
"required": false,
"description": "1-based index of the first result to return, used for pagination.",
"schema": {
"type": "integer"
}
},
{
"in": "query",
"name": "count",
"required": false,
"description": "Maximum number of results to return per page (maximum: 1,000,000).",
"schema": {
"type": "integer",
"maximum": 1000000
}
}
],
"responses": {
"200": {
"description": "The users are returned successfully.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ScimUsers"
}
}
}
},
"400": {
"description": "Bad request."
},
"401": {
"description": "Unauthorized."
},
"403": {
"description": "Forbidden."
},
"490": {
"description": "Request blocked by WAF"
}
}
}
},
"/rest/scim/Users": {
"post": {
"summary": "Create a user",
"description": "### Description:\n Creates a new SCIM user with the specified attributes.\n### Precondition:\n The request must be authenticated using a valid SCIM token.\n### Response:\n The newly created user is returned.\n",
"tags": [
"scim"
],
"parameters": [
{
"in": "query",
"name": "attributes",
"required": false,
"explode": true,
"style": "form",
"description": "Comma-separated list of attribute names to include in the response.",
"schema": {
"type": "array",
"items": {
"type": "string",
"enum": [
"id",
"meta",
"userName",
"displayName",
"userType",
"preferredLanguage",
"active",
"emails",
"phoneNumbers",
"photos",
"roles",
"meta.resourceType",
"meta.created",
"meta.location",
"urn:ietf:params:scim:schemas:core:2.0:User:id",
"urn:ietf:params:scim:schemas:core:2.0:User:meta",
"urn:ietf:params:scim:schemas:core:2.0:User:userName",
"urn:ietf:params:scim:schemas:core:2.0:User:displayName",
"urn:ietf:params:scim:schemas:core:2.0:User:userType",
"urn:ietf:params:scim:schemas:core:2.0:User:preferredLanguage",
"urn:ietf:params:scim:schemas:core:2.0:User:active",
"urn:ietf:params:scim:schemas:core:2.0:User:emails",
"urn:ietf:params:scim:schemas:core:2.0:User:phoneNumbers",
"urn:ietf:params:scim:schemas:core:2.0:User:photos",
"urn:ietf:params:scim:schemas:core:2.0:User:roles",
"urn:ietf:params:scim:schemas:core:2.0:User:meta.resourceType",
"urn:ietf:params:scim:schemas:core:2.0:User:meta.created",
"urn:ietf:params:scim:schemas:core:2.0:User:meta.location"
]
}
}
},
{
"in": "query",
"name": "excludedAttributes",
"required": false,
"explode": true,
"style": "form",
"description": "Comma-separated list of attribute names to exclude from the response.",
"schema": {
"type": "array",
"items": {
"type": "string",
"enum": [
"meta",
"userName",
"displayName",
"userType",
"preferredLanguage",
"active",
"emails",
"phoneNumbers",
"photos",
"roles",
"meta.resourceType",
"meta.created",
"meta.location",
"urn:ietf:params:scim:schemas:core:2.0:User:meta",
"urn:ietf:params:scim:schemas:core:2.0:User:userName",
"urn:ietf:params:scim:schemas:core:2.0:User:displayName",
"urn:ietf:params:scim:schemas:core:2.0:User:userType",
"urn:ietf:params:scim:schemas:core:2.0:User:preferredLanguage",
"urn:ietf:params:scim:schemas:core:2.0:User:active",
"urn:ietf:params:scim:schemas:core:2.0:User:emails",
"urn:ietf:params:scim:schemas:core:2.0:User:phoneNumbers",
"urn:ietf:params:scim:schemas:core:2.0:User:photos",
"urn:ietf:params:scim:schemas:core:2.0:User:roles",
"urn:ietf:params:scim:schemas:core:2.0:User:meta.resourceType",
"urn:ietf:params:scim:schemas:core:2.0:User:meta.created",
"urn:ietf:params:scim:schemas:core:2.0:User:meta.location"
]
}
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ScimUsersPostRequest"
}
}
}
},
"responses": {
"201": {
"description": "The user is created successfully.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ScimUser"
}
}
}
},
"400": {
"description": "Bad request."
},
"401": {
"description": "Unauthorized."
},
"403": {
"description": "Forbidden."
},
"409": {
"description": "Conflict."
},
"490": {
"description": "Request blocked by WAF"
}
}
},
"get": {
"summary": "Retrieve users",
"description": "### Description:\n Returns a paginated list of SCIM users matching the specified filter criteria.\n### Precondition:\n The request must be authenticated using a valid SCIM token.\n### Response:\n A list of SCIM users is returned.\n",
"tags": [
"scim"
],
"parameters": [
{
"in": "query",
"name": "attributes",
"required": false,
"explode": true,
"style": "form",
"description": "Comma-separated list of attribute names to include in the response.",
"schema": {
"type": "array",
"items": {
"type": "string",
"enum": [
"id",
"meta",
"userName",
"displayName",
"userType",
"preferredLanguage",
"active",
"emails",
"phoneNumbers",
"photos",
"roles",
"meta.resourceType",
"meta.created",
"meta.location",
"urn:ietf:params:scim:schemas:core:2.0:User:id",
"urn:ietf:params:scim:schemas:core:2.0:User:meta",
"urn:ietf:params:scim:schemas:core:2.0:User:userName",
"urn:ietf:params:scim:schemas:core:2.0:User:displayName",
"urn:ietf:params:scim:schemas:core:2.0:User:userType",
"urn:ietf:params:scim:schemas:core:2.0:User:preferredLanguage",
"urn:ietf:params:scim:schemas:core:2.0:User:active",
"urn:ietf:params:scim:schemas:core:2.0:User:emails",
"urn:ietf:params:scim:schemas:core:2.0:User:phoneNumbers",
"urn:ietf:params:scim:schemas:core:2.0:User:photos",
"urn:ietf:params:scim:schemas:core:2.0:User:roles",
"urn:ietf:params:scim:schemas:core:2.0:User:meta.resourceType",
"urn:ietf:params:scim:schemas:core:2.0:User:meta.created",
"urn:ietf:params:scim:schemas:core:2.0:User:meta.location"
]
}
}
},
{
"in": "query",
"name": "excludedAttributes",
"required": false,
"explode": true,
"style": "form",
"description": "Comma-separated list of attribute names to exclude from the response.",
"schema": {
"type": "array",
"items": {
"type": "string",
"enum": [
"meta",
"userName",
"displayName",
"userType",
"preferredLanguage",
"active",
"emails",
"phoneNumbers",
"photos",
"roles",
"meta.resourceType",
"meta.created",
"meta.location",
"urn:ietf:params:scim:schemas:core:2.0:User:meta",
"urn:ietf:params:scim:schemas:core:2.0:User:userName",
"urn:ietf:params:scim:schemas:core:2.0:User:displayName",
"urn:ietf:params:scim:schemas:core:2.0:User:userType",
"urn:ietf:params:scim:schemas:core:2.0:User:preferredLanguage",
"urn:ietf:params:scim:schemas:core:2.0:User:active",
"urn:ietf:params:scim:schemas:core:2.0:User:emails",
"urn:ietf:params:scim:schemas:core:2.0:User:phoneNumbers",
"urn:ietf:params:scim:schemas:core:2.0:User:photos",
"urn:ietf:params:scim:schemas:core:2.0:User:roles",
"urn:ietf:params:scim:schemas:core:2.0:User:meta.resourceType",
"urn:ietf:params:scim:schemas:core:2.0:User:meta.created",
"urn:ietf:params:scim:schemas:core:2.0:User:meta.location"
]
}
}
},
{
"in": "query",
"name": "filter",
"required": false,
"description": "SCIM filter expression to narrow the list of returned users (e.g., `userName eq \"user@example.com\"`).",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "sortBy",
"required": false,
"description": "Attribute name to sort results by.",
"schema": {
"type": "string",
"enum": [
"meta.created",
"meta.location",
"userName",
"displayName",
"userType",
"preferredLanguage",
"emails",
"emails.value",
"phoneNumbers",
"phoneNumbers.value",
"roles",
"roles.value",
"active",
"urn:ietf:params:scim:schemas:core:2.0:User:meta.created",
"urn:ietf:params:scim:schemas:core:2.0:User:meta.location",
"urn:ietf:params:scim:schemas:core:2.0:User:userName",
"urn:ietf:params:scim:schemas:core:2.0:User:displayName",
"urn:ietf:params:scim:schemas:core:2.0:User:userType",
"urn:ietf:params:scim:schemas:core:2.0:User:preferredLanguage",
"urn:ietf:params:scim:schemas:core:2.0:User:emails",
"urn:ietf:params:scim:schemas:core:2.0:User:emails.value",
"urn:ietf:params:scim:schemas:core:2.0:User:phoneNumbers",
"urn:ietf:params:scim:schemas:core:2.0:User:phoneNumbers.value",
"urn:ietf:params:scim:schemas:core:2.0:User:roles",
"urn:ietf:params:scim:schemas:core:2.0:User:roles.value",
"urn:ietf:params:scim:schemas:core:2.0:User:active"
]
}
},
{
"in": "query",
"name": "sortOrder",
"required": false,
"description": "Sort direction for the results.
`ascending` \u2013 Sort in ascending order.
`descending` \u2013 Sort in descending order.",
"schema": {
"type": "string",
"enum": [
"ascending",
"descending"
]
}
},
{
"in": "query",
"name": "startIndex",
"required": false,
"description": "1-based index of the first result to return, used for pagination.",
"schema": {
"type": "integer"
}
},
{
"in": "query",
"name": "count",
"required": false,
"description": "Maximum number of results to return per page (maximum: 1,000,000).",
"schema": {
"type": "integer",
"maximum": 1000000
}
}
],
"responses": {
"200": {
"description": "The users are returned successfully.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ScimUsers"
}
}
}
},
"400": {
"description": "Bad request."
},
"401": {
"description": "Unauthorized."
},
"403": {
"description": "Forbidden."
},
"490": {
"description": "Request blocked by WAF"
}
}
}
},
"/rest/scim/users/{id}": {
"put": {
"summary": "Update a user",
"description": "### Description:\n Updates the SCIM user corresponding to the provided ID.\n### Precondition:\n The request must be authenticated using a valid SCIM token.\n### Response:\n The updated user is returned.\n",
"tags": [
"scim"
],
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"description": "The unique identifier (UUID) of the entity.",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ScimUsersPutRequest"
}
}
}
},
"responses": {
"200": {
"description": "The user is updated and returned successfully.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ScimUser"
}
}
}
},
"401": {
"description": "ERR_AUTH_INVALID_CSRF\n\nERR_AUTH_UNAUTHORIZED\n"
},
"404": {
"description": "ERR_ENTITY_NOT_FOUND"
},
"490": {
"description": "Request blocked by WAF"
}
}
},
"get": {
"summary": "Return a user",
"description": "### Description:\n Returns the SCIM user corresponding to the provided ID.\n### Precondition:\n The request must be authenticated using a valid SCIM token.\n### Response:\n The user is returned.\n",
"tags": [
"scim"
],
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"description": "The unique identifier (UUID) of the entity.",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "query",
"name": "attributes",
"required": false,
"explode": true,
"style": "form",
"description": "Comma-separated list of attribute names to include in the response.",
"schema": {
"type": "array",
"items": {
"type": "string",
"enum": [
"id",
"meta",
"userName",
"displayName",
"userType",
"preferredLanguage",
"active",
"emails",
"phoneNumbers",
"photos",
"roles",
"meta.resourceType",
"meta.created",
"meta.location",
"urn:ietf:params:scim:schemas:core:2.0:User:id",
"urn:ietf:params:scim:schemas:core:2.0:User:meta",
"urn:ietf:params:scim:schemas:core:2.0:User:userName",
"urn:ietf:params:scim:schemas:core:2.0:User:displayName",
"urn:ietf:params:scim:schemas:core:2.0:User:userType",
"urn:ietf:params:scim:schemas:core:2.0:User:preferredLanguage",
"urn:ietf:params:scim:schemas:core:2.0:User:active",
"urn:ietf:params:scim:schemas:core:2.0:User:emails",
"urn:ietf:params:scim:schemas:core:2.0:User:phoneNumbers",
"urn:ietf:params:scim:schemas:core:2.0:User:photos",
"urn:ietf:params:scim:schemas:core:2.0:User:roles",
"urn:ietf:params:scim:schemas:core:2.0:User:meta.resourceType",
"urn:ietf:params:scim:schemas:core:2.0:User:meta.created",
"urn:ietf:params:scim:schemas:core:2.0:User:meta.location"
]
}
}
},
{
"in": "query",
"name": "excludedAttributes",
"required": false,
"explode": true,
"style": "form",
"description": "Comma-separated list of attribute names to exclude from the response.",
"schema": {
"type": "array",
"items": {
"type": "string",
"enum": [
"meta",
"userName",
"displayName",
"userType",
"preferredLanguage",
"active",
"emails",
"phoneNumbers",
"photos",
"roles",
"meta.resourceType",
"meta.created",
"meta.location",
"urn:ietf:params:scim:schemas:core:2.0:User:meta",
"urn:ietf:params:scim:schemas:core:2.0:User:userName",
"urn:ietf:params:scim:schemas:core:2.0:User:displayName",
"urn:ietf:params:scim:schemas:core:2.0:User:userType",
"urn:ietf:params:scim:schemas:core:2.0:User:preferredLanguage",
"urn:ietf:params:scim:schemas:core:2.0:User:active",
"urn:ietf:params:scim:schemas:core:2.0:User:emails",
"urn:ietf:params:scim:schemas:core:2.0:User:phoneNumbers",
"urn:ietf:params:scim:schemas:core:2.0:User:photos",
"urn:ietf:params:scim:schemas:core:2.0:User:roles",
"urn:ietf:params:scim:schemas:core:2.0:User:meta.resourceType",
"urn:ietf:params:scim:schemas:core:2.0:User:meta.created",
"urn:ietf:params:scim:schemas:core:2.0:User:meta.location"
]
}
}
}
],
"responses": {
"200": {
"description": "The user is returned successfully.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ScimUser"
}
}
}
},
"400": {
"description": "Bad request."
},
"401": {
"description": "Unauthorized."
},
"403": {
"description": "Forbidden."
},
"490": {
"description": "Request blocked by WAF"
}
}
},
"delete": {
"summary": "Delete a user",
"description": "### Description:\n Deletes the SCIM user corresponding to the provided ID.\n### Precondition:\n The request must be authenticated using a valid SCIM token.\n### Response:\n The user is deleted.\n",
"tags": [
"scim"
],
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"description": "The unique identifier (UUID) of the entity.",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "query",
"name": "remoteWipe",
"required": false,
"description": "If true, triggers a remote wipe of the user data from all registered devices.",
"schema": {
"type": "boolean",
"default": false
}
},
{
"in": "query",
"name": "deleteUnsharedData",
"required": false,
"description": "If true, permanently deletes data that is not shared with other users.",
"schema": {
"type": "boolean",
"default": null,
"nullable": true
}
},
{
"in": "query",
"name": "retainData",
"required": false,
"description": "If true, retains the user data after deletion.",
"schema": {
"type": "boolean",
"default": null,
"nullable": true
}
},
{
"in": "query",
"name": "retainPermissionToSharedData",
"required": false,
"description": "If true, the specified `retainToUser` will retain access to shared data.",
"schema": {
"type": "boolean",
"default": false
}
},
{
"in": "query",
"name": "retainToUser",
"required": false,
"description": "UUID of the user who will receive ownership of the deleted user data.",
"schema": {
"type": "string",
"default": false
}
}
],
"responses": {
"204": {
"description": "The user is deleted successfully."
},
"400": {
"description": "Bad request."
},
"401": {
"description": "Unauthorized."
},
"403": {
"description": "Forbidden."
},
"490": {
"description": "Request blocked by WAF"
}
}
}
},
"/rest/scim/Users/{id}": {
"put": {
"summary": "Update a user",
"description": "### Description:\n Updates the SCIM user corresponding to the provided ID.\n### Precondition:\n The request must be authenticated using a valid SCIM token.\n### Response:\n The updated user is returned.\n",
"tags": [
"scim"
],
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"description": "The unique identifier (UUID) of the entity.",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ScimUsersPutRequest"
}
}
}
},
"responses": {
"200": {
"description": "The user is updated and returned successfully.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ScimUser"
}
}
}
},
"401": {
"description": "ERR_AUTH_INVALID_CSRF\n\nERR_AUTH_UNAUTHORIZED\n"
},
"404": {
"description": "ERR_ENTITY_NOT_FOUND"
},
"490": {
"description": "Request blocked by WAF"
}
}
},
"get": {
"summary": "Return a user",
"description": "### Description:\n Returns the SCIM user corresponding to the provided ID.\n### Precondition:\n The request must be authenticated using a valid SCIM token.\n### Response:\n The user is returned.\n",
"tags": [
"scim"
],
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"description": "The unique identifier (UUID) of the entity.",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "query",
"name": "attributes",
"required": false,
"explode": true,
"style": "form",
"description": "Comma-separated list of attribute names to include in the response.",
"schema": {
"type": "array",
"items": {
"type": "string",
"enum": [
"id",
"meta",
"userName",
"displayName",
"userType",
"preferredLanguage",
"active",
"emails",
"phoneNumbers",
"photos",
"roles",
"meta.resourceType",
"meta.created",
"meta.location",
"urn:ietf:params:scim:schemas:core:2.0:User:id",
"urn:ietf:params:scim:schemas:core:2.0:User:meta",
"urn:ietf:params:scim:schemas:core:2.0:User:userName",
"urn:ietf:params:scim:schemas:core:2.0:User:displayName",
"urn:ietf:params:scim:schemas:core:2.0:User:userType",
"urn:ietf:params:scim:schemas:core:2.0:User:preferredLanguage",
"urn:ietf:params:scim:schemas:core:2.0:User:active",
"urn:ietf:params:scim:schemas:core:2.0:User:emails",
"urn:ietf:params:scim:schemas:core:2.0:User:phoneNumbers",
"urn:ietf:params:scim:schemas:core:2.0:User:photos",
"urn:ietf:params:scim:schemas:core:2.0:User:roles",
"urn:ietf:params:scim:schemas:core:2.0:User:meta.resourceType",
"urn:ietf:params:scim:schemas:core:2.0:User:meta.created",
"urn:ietf:params:scim:schemas:core:2.0:User:meta.location"
]
}
}
},
{
"in": "query",
"name": "excludedAttributes",
"required": false,
"explode": true,
"style": "form",
"description": "Comma-separated list of attribute names to exclude from the response.",
"schema": {
"type": "array",
"items": {
"type": "string",
"enum": [
"meta",
"userName",
"displayName",
"userType",
"preferredLanguage",
"active",
"emails",
"phoneNumbers",
"photos",
"roles",
"meta.resourceType",
"meta.created",
"meta.location",
"urn:ietf:params:scim:schemas:core:2.0:User:meta",
"urn:ietf:params:scim:schemas:core:2.0:User:userName",
"urn:ietf:params:scim:schemas:core:2.0:User:displayName",
"urn:ietf:params:scim:schemas:core:2.0:User:userType",
"urn:ietf:params:scim:schemas:core:2.0:User:preferredLanguage",
"urn:ietf:params:scim:schemas:core:2.0:User:active",
"urn:ietf:params:scim:schemas:core:2.0:User:emails",
"urn:ietf:params:scim:schemas:core:2.0:User:phoneNumbers",
"urn:ietf:params:scim:schemas:core:2.0:User:photos",
"urn:ietf:params:scim:schemas:core:2.0:User:roles",
"urn:ietf:params:scim:schemas:core:2.0:User:meta.resourceType",
"urn:ietf:params:scim:schemas:core:2.0:User:meta.created",
"urn:ietf:params:scim:schemas:core:2.0:User:meta.location"
]
}
}
}
],
"responses": {
"200": {
"description": "The user is returned successfully.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ScimUser"
}
}
}
},
"400": {
"description": "Bad request."
},
"401": {
"description": "Unauthorized."
},
"403": {
"description": "Forbidden."
},
"490": {
"description": "Request blocked by WAF"
}
}
},
"delete": {
"summary": "Delete a user",
"description": "### Description:\n Deletes the SCIM user corresponding to the provided ID.\n### Precondition:\n The request must be authenticated using a valid SCIM token.\n### Response:\n The user is deleted.\n",
"tags": [
"scim"
],
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"description": "The unique identifier (UUID) of the entity.",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "query",
"name": "remoteWipe",
"required": false,
"description": "If true, triggers a remote wipe of the user data from all registered devices.",
"schema": {
"type": "boolean",
"default": false
}
},
{
"in": "query",
"name": "deleteUnsharedData",
"required": false,
"description": "If true, permanently deletes data that is not shared with other users.",
"schema": {
"type": "boolean",
"default": null,
"nullable": true
}
},
{
"in": "query",
"name": "retainData",
"required": false,
"description": "If true, retains the user data after deletion.",
"schema": {
"type": "boolean",
"default": null,
"nullable": true
}
},
{
"in": "query",
"name": "retainPermissionToSharedData",
"required": false,
"description": "If true, the specified `retainToUser` will retain access to shared data.",
"schema": {
"type": "boolean",
"default": false
}
},
{
"in": "query",
"name": "retainToUser",
"required": false,
"description": "UUID of the user who will receive ownership of the deleted user data.",
"schema": {
"type": "string",
"default": false
}
}
],
"responses": {
"204": {
"description": "The user is deleted successfully."
},
"400": {
"description": "Bad request."
},
"401": {
"description": "Unauthorized."
},
"403": {
"description": "Forbidden."
},
"490": {
"description": "Request blocked by WAF"
}
}
}
},
"/rest/scim/ServiceProviderConfig": {
"get": {
"summary": "Return SCIM service provider configuration",
"description": "### Description:\n Returns the SCIM service provider configuration, including supported features and authentication schemes.\n### Precondition:\n The request must be authenticated using a valid SCIM token.\n### Response:\n The service provider configuration is returned.\n",
"tags": [
"scim"
],
"responses": {
"200": {
"description": "The service provider configuration is returned successfully."
},
"401": {
"description": "Unauthorized."
},
"403": {
"description": "Forbidden."
},
"490": {
"description": "Request blocked by WAF"
}
}
}
},
"/rest/scim/Schemas": {
"get": {
"summary": "Return SCIM schemas",
"description": "### Description:\n Returns all supported SCIM schemas.\n### Precondition:\n The request must be authenticated using a valid SCIM token.\n### Response:\n The supported SCIM schemas are returned.\n",
"tags": [
"scim"
],
"responses": {
"200": {
"description": "The supported SCIM schemas are returned successfully."
},
"401": {
"description": "Unauthorized."
},
"403": {
"description": "Forbidden."
},
"490": {
"description": "Request blocked by WAF"
}
}
}
},
"/rest/scim/Schemas/{id}": {
"get": {
"summary": "Return a SCIM schema",
"description": "### Description:\n Returns the SCIM schema corresponding to the provided ID.\n### Precondition:\n The request must be authenticated using a valid SCIM token.\n### Response:\n The requested SCIM schema is returned if it exists.\n",
"tags": [
"scim"
],
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"description": "The ID/URN of the schema",
"schema": {
"type": "string",
"enum": [
"User",
"urn:ietf:params:scim:schemas:core:2.0:User"
]
}
}
],
"responses": {
"200": {
"description": "The requested SCIM schema is returned successfully."
},
"401": {
"description": "Unauthorized."
},
"403": {
"description": "Forbidden."
},
"490": {
"description": "Request blocked by WAF"
}
}
}
},
"/rest/scim/ResourceTypes": {
"get": {
"summary": "Return SCIM resource types",
"description": "### Description:\n Returns all supported SCIM resource types.\n### Precondition:\n The request must be authenticated using a valid SCIM token.\n### Response:\n The supported SCIM resource types are returned.\n",
"tags": [
"scim"
],
"responses": {
"200": {
"description": "The supported SCIM resource types are returned successfully."
},
"401": {
"description": "Unauthorized."
},
"403": {
"description": "Forbidden."
},
"490": {
"description": "Request blocked by WAF"
}
}
}
},
"/rest/scim/ResourceTypes/{id}": {
"get": {
"summary": "Return a SCIM resource type",
"description": "### Description:\n Returns the SCIM resource type corresponding to the provided ID.\n### Precondition:\n The request must be authenticated using a valid SCIM token.\n### Response:\n The requested SCIM resource type is returned if it exists.\n",
"tags": [
"scim"
],
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"description": "The ID/URN of the schema",
"schema": {
"type": "string",
"enum": [
"User",
"urn:ietf:params:scim:schemas:core:2.0:User"
]
}
}
],
"responses": {
"200": {
"description": "The requested SCIM resource type is returned successfully."
},
"401": {
"description": "Unauthorized."
},
"403": {
"description": "Forbidden."
},
"490": {
"description": "Request blocked by WAF"
}
}
}
},
"/rest/nodeHealth/status": {
"get": {
"summary": "Get node health status for system monitoring",
"description": "### Description:\n Retrieves node health status information for system components including MariaDB cluster status, required services status, memory usage, and system load average.\n### Precondition:\n This endpoint is restricted by IP whitelist and rate limiting.\n### Response:\n Returns the overall node health status.\n",
"tags": [
"system"
],
"responses": {
"200": {
"description": "Node health status returned successfully - all components are healthy.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NodeHealthStatusResponse"
},
"example": {
"ok": 1
}
}
}
},
"503": {
"description": "Service unavailable - one or more components are unhealthy.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NodeHealthStatusResponse"
},
"example": {
"ok": 0
}
}
}
},
"490": {
"description": "Request blocked by WAF"
},
"500": {
"description": "ERR_INTERNAL_SERVER_ERROR"
}
}
}
},
"/rest/advancedForms/{id}/submissions": {
"post": {
"summary": "Create an upload link for an Advanced Form submission",
"description": "### Description:\n Creates a subfolder under the form owner's folder for the submission, then returns an upload link that the Advanced Form client can use to upload the submitted files.\n### Precondition:\n Caller must be an Advanced Forms client.\n The authenticated user must be the form owner.\n### Response:\n Returns an upload link pointing to the newly created submission subfolder.\n",
"tags": [
"internal",
"advancedForms"
],
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"description": "The unique identifier (UUID) of the entity.",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SubmissionRequest"
}
}
}
},
"responses": {
"201": {
"description": "The submission subfolder and upload link have been successfully created.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UploadLink"
}
}
}
},
"401": {
"description": "Unauthorized
Possible error codes: ERR_AUTH_INVALID_CSRF, ERR_AUTH_UNAUTHORIZED",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
},
"examples": {
"ERR_AUTH_INVALID_CSRF": {
"summary": "Invalid CSRF Authentication",
"description": "Invalid CSRF Authentication",
"value": {
"errors": [
{
"code": "ERR_AUTH_INVALID_CSRF",
"message": "Invalid CSRF Authentication"
}
]
}
},
"ERR_AUTH_UNAUTHORIZED": {
"summary": "Unauthorized",
"description": "Unauthorized",
"value": {
"errors": [
{
"code": "ERR_AUTH_UNAUTHORIZED",
"message": "Unauthorized"
}
]
}
}
}
}
}
},
"403": {
"description": "Forbidden
Possible error codes: ERR_ACCESS_USER, ERR_ACCESS_CLIENT",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
},
"examples": {
"ERR_ACCESS_USER": {
"summary": "Insufficient access permissions",
"description": "Insufficient access permissions",
"value": {
"errors": [
{
"code": "ERR_ACCESS_USER",
"message": "Insufficient access permissions"
}
]
}
},
"ERR_ACCESS_CLIENT": {
"summary": "Insufficient access permissions",
"description": "Insufficient access permissions",
"value": {
"errors": [
{
"code": "ERR_ACCESS_CLIENT",
"message": "Insufficient access permissions"
}
]
}
}
}
}
}
},
"404": {
"description": "Not Found
Possible error codes: ERR_ENTITY_NOT_FOUND",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
},
"examples": {
"ERR_ENTITY_NOT_FOUND": {
"summary": "Entity does not exist",
"description": "Entity does not exist",
"value": {
"errors": [
{
"code": "ERR_ENTITY_NOT_FOUND",
"message": "Entity does not exist"
}
]
}
}
}
}
}
},
"422": {
"description": "Unprocessable Content
Possible error codes: ERR_INPUT_INVALID_FORMAT",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
},
"examples": {
"ERR_INPUT_INVALID_FORMAT": {
"summary": "The input is invalid.",
"description": "The input is invalid.",
"value": {
"errors": [
{
"code": "ERR_INPUT_INVALID_FORMAT",
"message": "The input is invalid."
}
]
}
}
}
}
}
},
"490": {
"description": "Request blocked by WAF"
}
}
}
},
"/rest/admin/activities": {
"get": {
"summary": "Get admin activities list",
"description": "### Description:\n Retrieves the list of admin activities.\n### Precondition:\n The user must be an administrator with access to `Activity Log`.\n### Response:\n Returns the list of activities performed by the admin.\n### Sorting:\n Sort string syntax `FIELD_NAME:ORDER`.\n\n ORDER can be `asc` or `desc`.\n### Sorting options:\n | FIELD_NAME | Description |\n |------------|-------------|\n | created | The creation date and time of the activity |\n | client | The client name |\n | username | The username associated with the activity |\n | ip_address | The client IP address |\n",
"tags": [
"admin"
],
"parameters": [
{
"in": "query",
"name": "startDateTime",
"required": true,
"description": "The start date and time for the activity range.",
"schema": {
"type": "string",
"format": "date"
}
},
{
"in": "query",
"name": "endDateTime",
"required": true,
"description": "The end date and time for the activity range.",
"schema": {
"type": "string",
"format": "date"
}
},
{
"in": "query",
"name": "eventFilters:in",
"required": false,
"explode": true,
"style": "form",
"description": "Comma-separated list of event filters to filter the activities.",
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
{
"in": "query",
"name": "objectIds:in",
"required": false,
"explode": true,
"style": "form",
"description": "Comma-separated list of object IDs to filter the activities.",
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
{
"in": "query",
"name": "userId",
"required": false,
"description": "User ID to filter activities by a specific user.",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "maxPages",
"required": false,
"description": "Maximum number of pages to retrieve.",
"schema": {
"type": "integer",
"minimum": -1
}
},
{
"in": "query",
"name": "orderBy",
"required": false,
"description": "Sort order for the results. Default is `created:desc`.
Allowed values: `created:asc`, `created:desc`, `client:asc`, `client:desc`, `username:asc`, `username:desc`, `ip_address:asc`, `ip_address:desc`.",
"schema": {
"type": "string",
"enum": [
"created:asc",
"created:desc",
"client:asc",
"client:desc",
"username:asc",
"username:desc",
"ip_address:asc",
"ip_address:desc"
]
}
},
{
"in": "query",
"name": "compact",
"required": false,
"description": "If true, returns a more compact response.",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "limit",
"required": false,
"description": "Maximum number of items to return.",
"schema": {
"type": "integer",
"minimum": 1,
"maximum": 10000
}
},
{
"in": "query",
"name": "offset",
"required": false,
"description": "Number of items to skip before returning results, for pagination.",
"schema": {
"type": "integer",
"minimum": 0
}
}
],
"responses": {
"200": {
"description": "The admin activities list is successfully returned.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActivityList"
}
}
}
},
"401": {
"description": "Unauthorized
Possible error codes: ERR_ACCESS_USER, ERR_AUTH_INVALID_CSRF, ERR_AUTH_UNAUTHORIZED",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
},
"examples": {
"ERR_ACCESS_USER": {
"summary": "Insufficient access permissions",
"description": "Insufficient access permissions",
"value": {
"errors": [
{
"code": "ERR_ACCESS_USER",
"message": "Insufficient access permissions"
}
]
}
},
"ERR_AUTH_INVALID_CSRF": {
"summary": "Invalid CSRF Authentication",
"description": "Invalid CSRF Authentication",
"value": {
"errors": [
{
"code": "ERR_AUTH_INVALID_CSRF",
"message": "Invalid CSRF Authentication"
}
]
}
},
"ERR_AUTH_UNAUTHORIZED": {
"summary": "Unauthorized",
"description": "Unauthorized",
"value": {
"errors": [
{
"code": "ERR_AUTH_UNAUTHORIZED",
"message": "Unauthorized"
}
]
}
}
}
}
}
},
"422": {
"description": "Unprocessable Content
Possible error codes: ERR_INVALID_PARAMETER",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
},
"examples": {
"ERR_INVALID_PARAMETER": {
"summary": "Invalid Parameter Exception",
"description": "Invalid Parameter Exception",
"value": {
"errors": [
{
"code": "ERR_INVALID_PARAMETER",
"message": "Invalid Parameter Exception"
}
]
}
}
}
}
}
},
"490": {
"description": "Request blocked by WAF"
}
}
}
},
"/rest/admin/activities/{id}": {
"get": {
"summary": "Get admin activity detail",
"description": "### Description:\n Retrieves detailed information about a specific activity.\n### Precondition:\n The user must be an administrator with access to `Activity Log`.\n### Response:\n Returns the full details of the specified activity.\n",
"tags": [
"admin"
],
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"description": "The unique identifier (UUID) of the entity.",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "Successfully retrieved the activity details.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActivityList"
}
}
}
},
"401": {
"description": "Unauthorized
Possible error codes: ERR_ACCESS_USER, ERR_AUTH_INVALID_CSRF, ERR_AUTH_UNAUTHORIZED",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
},
"examples": {
"ERR_ACCESS_USER": {
"summary": "Insufficient access permissions",
"description": "Insufficient access permissions",
"value": {
"errors": [
{
"code": "ERR_ACCESS_USER",
"message": "Insufficient access permissions"
}
]
}
},
"ERR_AUTH_INVALID_CSRF": {
"summary": "Invalid CSRF Authentication",
"description": "Invalid CSRF Authentication",
"value": {
"errors": [
{
"code": "ERR_AUTH_INVALID_CSRF",
"message": "Invalid CSRF Authentication"
}
]
}
},
"ERR_AUTH_UNAUTHORIZED": {
"summary": "Unauthorized",
"description": "Unauthorized",
"value": {
"errors": [
{
"code": "ERR_AUTH_UNAUTHORIZED",
"message": "Unauthorized"
}
]
}
}
}
}
}
},
"422": {
"description": "Unprocessable Content
Possible error codes: ERR_INVALID_PARAMETER",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
},
"examples": {
"ERR_INVALID_PARAMETER": {
"summary": "Invalid Parameter Exception",
"description": "Invalid Parameter Exception",
"value": {
"errors": [
{
"code": "ERR_INVALID_PARAMETER",
"message": "Invalid Parameter Exception"
}
]
}
}
}
}
}
},
"490": {
"description": "Request blocked by WAF"
}
}
}
},
"/rest/admin/activities/actions/exportCSV": {
"get": {
"summary": "Export admin activities list",
"description": "### Description:\n Exports the list of admin activities based on the provided filters.\n### Precondition:\n The user must be an administrator with access to `Activity Log`.\n### Response:\n The admin activities list is generated and sent via email to the requesting user.\n### Sorting:\n Sort string syntax `FIELD_NAME:ORDER`.\n\n ORDER can be `asc` or `desc`.\n### Sorting options:\n | FIELD_NAME | Description |\n |------------|-------------|\n | created | The creation date and time of the activity |\n | client | The client name |\n | username | The username associated with the activity |\n | ip_address | The client IP address |\n",
"tags": [
"admin"
],
"parameters": [
{
"in": "query",
"name": "startDateTime",
"required": true,
"description": "The start date and time for the activity range.",
"schema": {
"type": "string",
"format": "date"
}
},
{
"in": "query",
"name": "endDateTime",
"required": true,
"description": "The end date and time for the activity range.",
"schema": {
"type": "string",
"format": "date"
}
},
{
"in": "query",
"name": "eventFilters:in",
"required": false,
"explode": true,
"style": "form",
"description": "Comma-separated list of event filters to filter the activities.",
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
{
"in": "query",
"name": "objectIds:in",
"required": false,
"explode": true,
"style": "form",
"description": "Comma-separated list of object IDs to filter the activities.",
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
{
"in": "query",
"name": "userId",
"required": false,
"description": "User ID to filter activities by a specific user.",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "maxPages",
"required": false,
"description": "Maximum number of pages to retrieve.",
"schema": {
"type": "integer",
"minimum": -1
}
},
{
"in": "query",
"name": "orderBy",
"required": false,
"description": "Sort order for the results. Default is `created:desc`.
Allowed values: `created:asc`, `created:desc`, `client:asc`, `client:desc`, `username:asc`, `username:desc`, `ip_address:asc`, `ip_address:desc`.",
"schema": {
"type": "string",
"enum": [
"created:asc",
"created:desc",
"client:asc",
"client:desc",
"username:asc",
"username:desc",
"ip_address:asc",
"ip_address:desc"
]
}
},
{
"in": "query",
"name": "compact",
"required": false,
"description": "If true, returns a more compact response.",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "limit",
"required": false,
"description": "Maximum number of items to return.",
"schema": {
"type": "integer",
"minimum": 1,
"maximum": 10000
}
},
{
"in": "query",
"name": "offset",
"required": false,
"description": "Number of items to skip before returning results, for pagination.",
"schema": {
"type": "integer",
"minimum": 0
}
}
],
"responses": {
"200": {
"description": "The admin activities list is being processed and will be sent via email."
},
"401": {
"description": "Unauthorized
Possible error codes: ERR_ACCESS_USER, ERR_AUTH_INVALID_CSRF, ERR_AUTH_UNAUTHORIZED",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
},
"examples": {
"ERR_ACCESS_USER": {
"summary": "Insufficient access permissions",
"description": "Insufficient access permissions",
"value": {
"errors": [
{
"code": "ERR_ACCESS_USER",
"message": "Insufficient access permissions"
}
]
}
},
"ERR_AUTH_INVALID_CSRF": {
"summary": "Invalid CSRF Authentication",
"description": "Invalid CSRF Authentication",
"value": {
"errors": [
{
"code": "ERR_AUTH_INVALID_CSRF",
"message": "Invalid CSRF Authentication"
}
]
}
},
"ERR_AUTH_UNAUTHORIZED": {
"summary": "Unauthorized",
"description": "Unauthorized",
"value": {
"errors": [
{
"code": "ERR_AUTH_UNAUTHORIZED",
"message": "Unauthorized"
}
]
}
}
}
}
}
},
"422": {
"description": "Unprocessable Content
Possible error codes: ERR_INVALID_PARAMETER",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
},
"examples": {
"ERR_INVALID_PARAMETER": {
"summary": "Invalid Parameter Exception",
"description": "Invalid Parameter Exception",
"value": {
"errors": [
{
"code": "ERR_INVALID_PARAMETER",
"message": "Invalid Parameter Exception"
}
]
}
}
}
}
}
},
"490": {
"description": "Request blocked by WAF"
}
}
}
},
"/rest/system/epgdb/import/{id}": {
"post": {
"summary": "Upload EPGDB backup chunk for database restore",
"description": "Endpoint for uploading a chunk to an existing EPGDB backup upload session, identified by its session ID.",
"tags": [
"system"
],
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"description": "The upload session ID",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EpgdbImportRequest"
}
}
}
},
"responses": {
"200": {
"description": "Successfully received the upload",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EpgdbImportPost"
}
}
}
},
"401": {
"description": "Unauthorized
Possible error codes: ERR_AUTH_INVALID_CSRF, ERR_AUTH_UNAUTHORIZED",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
},
"examples": {
"ERR_AUTH_INVALID_CSRF": {
"summary": "Invalid CSRF Authentication",
"description": "Invalid CSRF Authentication",
"value": {
"errors": [
{
"code": "ERR_AUTH_INVALID_CSRF",
"message": "Invalid CSRF Authentication"
}
]
}
},
"ERR_AUTH_UNAUTHORIZED": {
"summary": "Unauthorized",
"description": "Unauthorized",
"value": {
"errors": [
{
"code": "ERR_AUTH_UNAUTHORIZED",
"message": "Unauthorized"
}
]
}
}
}
}
}
},
"403": {
"description": "Forbidden
Possible error codes: ERR_ACCESS_DENIED, ERR_ACCESS_USER",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
},
"examples": {
"ERR_ACCESS_DENIED": {
"summary": "Your access is denied.",
"description": "Your access is denied.",
"value": {
"errors": [
{
"code": "ERR_ACCESS_DENIED",
"message": "Your access is denied.",
"redirectUrl": "/login?code=3317"
}
]
}
},
"ERR_ACCESS_USER": {
"summary": "Insufficient access permissions",
"description": "Insufficient access permissions",
"value": {
"errors": [
{
"code": "ERR_ACCESS_USER",
"message": "Insufficient access permissions"
}
]
}
}
}
}
}
},
"422": {
"description": "Unprocessable Content
Possible error codes: ERR_INVALID_PARAMETER, ERR_FILE_TOO_LARGE",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
},
"examples": {
"ERR_INVALID_PARAMETER": {
"summary": "Invalid Parameter Exception",
"description": "Invalid Parameter Exception",
"value": {
"errors": [
{
"code": "ERR_INVALID_PARAMETER",
"message": "Invalid Parameter Exception"
}
]
}
},
"ERR_FILE_TOO_LARGE": {
"summary": "Size of the file exceeds the allowed limit.",
"description": "Size of the file exceeds the allowed limit.",
"value": {
"errors": [
{
"code": "ERR_FILE_TOO_LARGE",
"message": "Size of the file exceeds the allowed limit."
}
]
}
}
}
}
}
},
"503": {
"description": "Service Unavailable
Possible error codes: ERR_SESSION_LIMIT_REACHED, ERR_UPLOAD_CHUNK_FAILED",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
},
"examples": {
"ERR_SESSION_LIMIT_REACHED": {
"summary": "Session limit reached. Unable to create a new session.",
"description": "Session limit reached. Unable to create a new session.",
"value": {
"errors": [
{
"code": "ERR_SESSION_LIMIT_REACHED",
"message": "Session limit reached. Unable to create a new session."
}
]
}
},
"ERR_UPLOAD_CHUNK_FAILED": {
"summary": "Upload chunk failed.",
"description": "Upload chunk failed.",
"value": {
"errors": [
{
"code": "ERR_UPLOAD_CHUNK_FAILED",
"message": "Upload chunk failed."
}
]
}
}
}
}
}
},
"507": {
"description": "Insufficient Storage
Possible error codes: ERR_INSUFFICIENT_DISK_SPACE",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
},
"examples": {
"ERR_INSUFFICIENT_DISK_SPACE": {
"summary": "Server does not have enough storage to process the upload.",
"description": "Server does not have enough storage to process the upload.",
"value": {
"errors": [
{
"code": "ERR_INSUFFICIENT_DISK_SPACE",
"message": "Server does not have enough storage to process the upload."
}
]
}
}
}
}
}
},
"490": {
"description": "Request blocked by WAF"
}
}
}
},
"/rest/system/epgdb/import": {
"post": {
"summary": "Upload EPGDB backup for database restore",
"description": "Endpoint for uploading an EPGDB backup for restoring the database. Starts a new upload session.",
"tags": [
"system"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EpgdbImportRequest"
}
}
}
},
"responses": {
"200": {
"description": "Successfully received the upload",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EpgdbImportPost"
}
}
}
},
"401": {
"description": "Unauthorized
Possible error codes: ERR_AUTH_INVALID_CSRF, ERR_AUTH_UNAUTHORIZED",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
},
"examples": {
"ERR_AUTH_INVALID_CSRF": {
"summary": "Invalid CSRF Authentication",
"description": "Invalid CSRF Authentication",
"value": {
"errors": [
{
"code": "ERR_AUTH_INVALID_CSRF",
"message": "Invalid CSRF Authentication"
}
]
}
},
"ERR_AUTH_UNAUTHORIZED": {
"summary": "Unauthorized",
"description": "Unauthorized",
"value": {
"errors": [
{
"code": "ERR_AUTH_UNAUTHORIZED",
"message": "Unauthorized"
}
]
}
}
}
}
}
},
"403": {
"description": "Forbidden
Possible error codes: ERR_ACCESS_DENIED, ERR_ACCESS_USER",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
},
"examples": {
"ERR_ACCESS_DENIED": {
"summary": "Your access is denied.",
"description": "Your access is denied.",
"value": {
"errors": [
{
"code": "ERR_ACCESS_DENIED",
"message": "Your access is denied.",
"redirectUrl": "/login?code=3317"
}
]
}
},
"ERR_ACCESS_USER": {
"summary": "Insufficient access permissions",
"description": "Insufficient access permissions",
"value": {
"errors": [
{
"code": "ERR_ACCESS_USER",
"message": "Insufficient access permissions"
}
]
}
}
}
}
}
},
"422": {
"description": "Unprocessable Content
Possible error codes: ERR_INVALID_PARAMETER, ERR_FILE_TOO_LARGE",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
},
"examples": {
"ERR_INVALID_PARAMETER": {
"summary": "Invalid Parameter Exception",
"description": "Invalid Parameter Exception",
"value": {
"errors": [
{
"code": "ERR_INVALID_PARAMETER",
"message": "Invalid Parameter Exception"
}
]
}
},
"ERR_FILE_TOO_LARGE": {
"summary": "Size of the file exceeds the allowed limit.",
"description": "Size of the file exceeds the allowed limit.",
"value": {
"errors": [
{
"code": "ERR_FILE_TOO_LARGE",
"message": "Size of the file exceeds the allowed limit."
}
]
}
}
}
}
}
},
"503": {
"description": "Service Unavailable
Possible error codes: ERR_SESSION_LIMIT_REACHED, ERR_UPLOAD_CHUNK_FAILED",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
},
"examples": {
"ERR_SESSION_LIMIT_REACHED": {
"summary": "Session limit reached. Unable to create a new session.",
"description": "Session limit reached. Unable to create a new session.",
"value": {
"errors": [
{
"code": "ERR_SESSION_LIMIT_REACHED",
"message": "Session limit reached. Unable to create a new session."
}
]
}
},
"ERR_UPLOAD_CHUNK_FAILED": {
"summary": "Upload chunk failed.",
"description": "Upload chunk failed.",
"value": {
"errors": [
{
"code": "ERR_UPLOAD_CHUNK_FAILED",
"message": "Upload chunk failed."
}
]
}
}
}
}
}
},
"507": {
"description": "Insufficient Storage
Possible error codes: ERR_INSUFFICIENT_DISK_SPACE",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
},
"examples": {
"ERR_INSUFFICIENT_DISK_SPACE": {
"summary": "Server does not have enough storage to process the upload.",
"description": "Server does not have enough storage to process the upload.",
"value": {
"errors": [
{
"code": "ERR_INSUFFICIENT_DISK_SPACE",
"message": "Server does not have enough storage to process the upload."
}
]
}
}
}
}
}
},
"490": {
"description": "Request blocked by WAF"
}
}
},
"get": {
"summary": "Get EPGDB import status",
"description": "Endpoint for polling the status of the import",
"tags": [
"system"
],
"responses": {
"200": {
"description": "Successfully returned the import status"
},
"401": {
"description": "Unauthorized
Possible error codes: ERR_AUTH_INVALID_CSRF, ERR_AUTH_UNAUTHORIZED",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
},
"examples": {
"ERR_AUTH_INVALID_CSRF": {
"summary": "Invalid CSRF Authentication",
"description": "Invalid CSRF Authentication",
"value": {
"errors": [
{
"code": "ERR_AUTH_INVALID_CSRF",
"message": "Invalid CSRF Authentication"
}
]
}
},
"ERR_AUTH_UNAUTHORIZED": {
"summary": "Unauthorized",
"description": "Unauthorized",
"value": {
"errors": [
{
"code": "ERR_AUTH_UNAUTHORIZED",
"message": "Unauthorized"
}
]
}
}
}
}
}
},
"403": {
"description": "Forbidden
Possible error codes: ERR_ACCESS_DENIED, ERR_ACCESS_USER",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
},
"examples": {
"ERR_ACCESS_DENIED": {
"summary": "Your access is denied.",
"description": "Your access is denied.",
"value": {
"errors": [
{
"code": "ERR_ACCESS_DENIED",
"message": "Your access is denied.",
"redirectUrl": "/login?code=3317"
}
]
}
},
"ERR_ACCESS_USER": {
"summary": "Insufficient access permissions",
"description": "Insufficient access permissions",
"value": {
"errors": [
{
"code": "ERR_ACCESS_USER",
"message": "Insufficient access permissions"
}
]
}
}
}
}
}
},
"422": {
"description": "Unprocessable Content
Possible error codes: ERR_INVALID_PARAMETER",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
},
"examples": {
"ERR_INVALID_PARAMETER": {
"summary": "Invalid Parameter Exception",
"description": "Invalid Parameter Exception",
"value": {
"errors": [
{
"code": "ERR_INVALID_PARAMETER",
"message": "Invalid Parameter Exception"
}
]
}
}
}
}
}
},
"490": {
"description": "Request blocked by WAF"
}
}
},
"delete": {
"summary": "Cancel active EPGDB import session",
"description": "Endpoint for cancelling the current active import session",
"tags": [
"system"
],
"responses": {
"200": {
"description": "Successfully deleted the session"
},
"401": {
"description": "Unauthorized
Possible error codes: ERR_AUTH_INVALID_CSRF, ERR_AUTH_UNAUTHORIZED",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
},
"examples": {
"ERR_AUTH_INVALID_CSRF": {
"summary": "Invalid CSRF Authentication",
"description": "Invalid CSRF Authentication",
"value": {
"errors": [
{
"code": "ERR_AUTH_INVALID_CSRF",
"message": "Invalid CSRF Authentication"
}
]
}
},
"ERR_AUTH_UNAUTHORIZED": {
"summary": "Unauthorized",
"description": "Unauthorized",
"value": {
"errors": [
{
"code": "ERR_AUTH_UNAUTHORIZED",
"message": "Unauthorized"
}
]
}
}
}
}
}
},
"403": {
"description": "Forbidden
Possible error codes: ERR_ACCESS_DENIED, ERR_ACCESS_USER",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
},
"examples": {
"ERR_ACCESS_DENIED": {
"summary": "Your access is denied.",
"description": "Your access is denied.",
"value": {
"errors": [
{
"code": "ERR_ACCESS_DENIED",
"message": "Your access is denied.",
"redirectUrl": "/login?code=3317"
}
]
}
},
"ERR_ACCESS_USER": {
"summary": "Insufficient access permissions",
"description": "Insufficient access permissions",
"value": {
"errors": [
{
"code": "ERR_ACCESS_USER",
"message": "Insufficient access permissions"
}
]
}
}
}
}
}
},
"490": {
"description": "Request blocked by WAF"
}
}
}
},
"/rest/system/epgdb/export/{filename}": {
"get": {
"summary": "Download EPGDB export file",
"description": "Get EPGDB export download",
"tags": [
"system"
],
"parameters": [
{
"in": "path",
"name": "filename",
"required": true,
"description": "The name of the EPGDB export file to download.",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "EPGDB export download"
},
"401": {
"description": "Unauthorized
Possible error codes: ERR_AUTH_INVALID_CSRF, ERR_AUTH_UNAUTHORIZED",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
},
"examples": {
"ERR_AUTH_INVALID_CSRF": {
"summary": "Invalid CSRF Authentication",
"description": "Invalid CSRF Authentication",
"value": {
"errors": [
{
"code": "ERR_AUTH_INVALID_CSRF",
"message": "Invalid CSRF Authentication"
}
]
}
},
"ERR_AUTH_UNAUTHORIZED": {
"summary": "Unauthorized",
"description": "Unauthorized",
"value": {
"errors": [
{
"code": "ERR_AUTH_UNAUTHORIZED",
"message": "Unauthorized"
}
]
}
}
}
}
}
},
"403": {
"description": "Forbidden
Possible error codes: ERR_ACCESS_DENIED, ERR_ACCESS_USER, ERR_DB_BACKUP_FAILED",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
},
"examples": {
"ERR_ACCESS_DENIED": {
"summary": "Your access is denied.",
"description": "Your access is denied.",
"value": {
"errors": [
{
"code": "ERR_ACCESS_DENIED",
"message": "Your access is denied.",
"redirectUrl": "/login?code=3317"
}
]
}
},
"ERR_ACCESS_USER": {
"summary": "Insufficient access permissions",
"description": "Insufficient access permissions",
"value": {
"errors": [
{
"code": "ERR_ACCESS_USER",
"message": "Insufficient access permissions"
}
]
}
},
"ERR_DB_BACKUP_FAILED": {
"summary": "Database backup failed due to an unexpected error",
"description": "Database backup failed due to an unexpected error",
"value": {
"errors": [
{
"code": "ERR_DB_BACKUP_FAILED",
"message": "Database backup failed due to an unexpected error"
}
]
}
}
}
}
}
},
"490": {
"description": "Request blocked by WAF"
}
}
}
},
"/rest/system/epgdb/export": {
"post": {
"summary": "Start EPGDB export",
"description": "Start EPGDB export with precheck validation",
"tags": [
"system"
],
"responses": {
"200": {
"description": "EPGDB export started successfully"
},
"401": {
"description": "Unauthorized
Possible error codes: ERR_AUTH_INVALID_CSRF, ERR_AUTH_UNAUTHORIZED",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
},
"examples": {
"ERR_AUTH_INVALID_CSRF": {
"summary": "Invalid CSRF Authentication",
"description": "Invalid CSRF Authentication",
"value": {
"errors": [
{
"code": "ERR_AUTH_INVALID_CSRF",
"message": "Invalid CSRF Authentication"
}
]
}
},
"ERR_AUTH_UNAUTHORIZED": {
"summary": "Unauthorized",
"description": "Unauthorized",
"value": {
"errors": [
{
"code": "ERR_AUTH_UNAUTHORIZED",
"message": "Unauthorized"
}
]
}
}
}
}
}
},
"403": {
"description": "Forbidden
Possible error codes: ERR_ACCESS_DENIED, ERR_ACCESS_USER, ERR_JOB_IN_PROGRESS",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
},
"examples": {
"ERR_ACCESS_DENIED": {
"summary": "Your access is denied.",
"description": "Your access is denied.",
"value": {
"errors": [
{
"code": "ERR_ACCESS_DENIED",
"message": "Your access is denied.",
"redirectUrl": "/login?code=3317"
}
]
}
},
"ERR_ACCESS_USER": {
"summary": "Insufficient access permissions",
"description": "Insufficient access permissions",
"value": {
"errors": [
{
"code": "ERR_ACCESS_USER",
"message": "Insufficient access permissions"
}
]
}
},
"ERR_JOB_IN_PROGRESS": {
"summary": "The job is currently still in progress",
"description": "The job is currently still in progress",
"value": {
"errors": [
{
"code": "ERR_JOB_IN_PROGRESS",
"message": "The job is currently still in progress"
}
]
}
}
}
}
}
},
"404": {
"description": "Not Found
Possible error codes: ERR_EPGDB_NOT_FOUND",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
},
"examples": {
"ERR_EPGDB_NOT_FOUND": {
"summary": "Failed to locate EPGDB",
"description": "Failed to locate EPGDB",
"value": {
"errors": [
{
"code": "ERR_EPGDB_NOT_FOUND",
"message": "Failed to locate EPGDB"
}
]
}
}
}
}
}
},
"507": {
"description": "Insufficient Storage
Possible error codes: ERR_INSUFFICIENT_TMP_STORAGE",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
},
"examples": {
"ERR_INSUFFICIENT_TMP_STORAGE": {
"summary": "Insufficient storage space in the Tmp storage partition",
"description": "Insufficient storage space in the Tmp storage partition",
"value": {
"errors": [
{
"code": "ERR_INSUFFICIENT_TMP_STORAGE",
"message": "Insufficient storage space in the Tmp storage partition"
}
]
}
}
}
}
}
},
"490": {
"description": "Request blocked by WAF"
}
}
},
"get": {
"summary": "Get EPGDB export status",
"description": "Get EPGDB export status",
"tags": [
"system"
],
"responses": {
"200": {
"description": "EPGDB export status returned successfully"
},
"401": {
"description": "Unauthorized
Possible error codes: ERR_AUTH_INVALID_CSRF, ERR_AUTH_UNAUTHORIZED",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
},
"examples": {
"ERR_AUTH_INVALID_CSRF": {
"summary": "Invalid CSRF Authentication",
"description": "Invalid CSRF Authentication",
"value": {
"errors": [
{
"code": "ERR_AUTH_INVALID_CSRF",
"message": "Invalid CSRF Authentication"
}
]
}
},
"ERR_AUTH_UNAUTHORIZED": {
"summary": "Unauthorized",
"description": "Unauthorized",
"value": {
"errors": [
{
"code": "ERR_AUTH_UNAUTHORIZED",
"message": "Unauthorized"
}
]
}
}
}
}
}
},
"403": {
"description": "Forbidden
Possible error codes: ERR_ACCESS_DENIED, ERR_ACCESS_USER",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
},
"examples": {
"ERR_ACCESS_DENIED": {
"summary": "Your access is denied.",
"description": "Your access is denied.",
"value": {
"errors": [
{
"code": "ERR_ACCESS_DENIED",
"message": "Your access is denied.",
"redirectUrl": "/login?code=3317"
}
]
}
},
"ERR_ACCESS_USER": {
"summary": "Insufficient access permissions",
"description": "Insufficient access permissions",
"value": {
"errors": [
{
"code": "ERR_ACCESS_USER",
"message": "Insufficient access permissions"
}
]
}
}
}
}
}
},
"490": {
"description": "Request blocked by WAF"
}
}
},
"delete": {
"summary": "Perform cleanup for EPGDB export",
"description": "Perform cleanup for EPGDB export",
"tags": [
"system"
],
"responses": {
"200": {
"description": "Delete EPGDB export"
},
"401": {
"description": "Unauthorized
Possible error codes: ERR_AUTH_INVALID_CSRF, ERR_AUTH_UNAUTHORIZED",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
},
"examples": {
"ERR_AUTH_INVALID_CSRF": {
"summary": "Invalid CSRF Authentication",
"description": "Invalid CSRF Authentication",
"value": {
"errors": [
{
"code": "ERR_AUTH_INVALID_CSRF",
"message": "Invalid CSRF Authentication"
}
]
}
},
"ERR_AUTH_UNAUTHORIZED": {
"summary": "Unauthorized",
"description": "Unauthorized",
"value": {
"errors": [
{
"code": "ERR_AUTH_UNAUTHORIZED",
"message": "Unauthorized"
}
]
}
}
}
}
}
},
"403": {
"description": "Forbidden
Possible error codes: ERR_ACCESS_DENIED, ERR_ACCESS_USER, ERR_JOB_IN_PROGRESS",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
},
"examples": {
"ERR_ACCESS_DENIED": {
"summary": "Your access is denied.",
"description": "Your access is denied.",
"value": {
"errors": [
{
"code": "ERR_ACCESS_DENIED",
"message": "Your access is denied.",
"redirectUrl": "/login?code=3317"
}
]
}
},
"ERR_ACCESS_USER": {
"summary": "Insufficient access permissions",
"description": "Insufficient access permissions",
"value": {
"errors": [
{
"code": "ERR_ACCESS_USER",
"message": "Insufficient access permissions"
}
]
}
},
"ERR_JOB_IN_PROGRESS": {
"summary": "The job is currently still in progress",
"description": "The job is currently still in progress",
"value": {
"errors": [
{
"code": "ERR_JOB_IN_PROGRESS",
"message": "The job is currently still in progress"
}
]
}
}
}
}
}
},
"490": {
"description": "Request blocked by WAF"
}
}
}
},
"/rest/admin/sharedMailboxes": {
"post": {
"summary": "Create a shared mailbox",
"description": "### Description:\n Converts the specified user account into a shared mailbox and assigns the specified members.\n### Precondition:\n Caller must have system, application, or helpdesk admin role.\n### Response:\n The shared mailbox is created and its details are returned.\n",
"tags": [
"sharedMailbox"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SharedMailboxPostRequest"
}
}
}
},
"responses": {
"201": {
"description": "The shared mailbox has been created successfully.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SharedMailbox"
}
}
}
},
"401": {
"description": "Unauthorized
Possible error codes: ERR_AUTH_INVALID_CSRF, ERR_AUTH_UNAUTHORIZED",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
},
"examples": {
"ERR_AUTH_INVALID_CSRF": {
"summary": "Invalid CSRF Authentication",
"description": "Invalid CSRF Authentication",
"value": {
"errors": [
{
"code": "ERR_AUTH_INVALID_CSRF",
"message": "Invalid CSRF Authentication"
}
]
}
},
"ERR_AUTH_UNAUTHORIZED": {
"summary": "Unauthorized",
"description": "Unauthorized",
"value": {
"errors": [
{
"code": "ERR_AUTH_UNAUTHORIZED",
"message": "Unauthorized"
}
]
}
}
}
}
}
},
"403": {
"description": "Forbidden
Possible error codes: ERR_ACCESS_ADMIN, ERR_ACCESS_USER, ERR_ADMIN_ROLE_RANK_RESTRICTED, ERR_NOT_INTERNAL_DOMAIN",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
},
"examples": {
"ERR_ACCESS_ADMIN": {
"summary": "Insufficient admin access permissions",
"description": "Insufficient admin access permissions",
"value": {
"errors": [
{
"code": "ERR_ACCESS_ADMIN",
"message": "Insufficient admin access permissions"
}
]
}
},
"ERR_ACCESS_USER": {
"summary": "Insufficient access permissions",
"description": "Insufficient access permissions",
"value": {
"errors": [
{
"code": "ERR_ACCESS_USER",
"message": "Insufficient access permissions"
}
]
}
},
"ERR_ADMIN_ROLE_RANK_RESTRICTED": {
"summary": "Action is restricted due to admin role rank",
"description": "Action is restricted due to admin role rank",
"value": {
"errors": [
{
"code": "ERR_ADMIN_ROLE_RANK_RESTRICTED",
"message": "Action is restricted due to admin role rank"
}
]
}
},
"ERR_NOT_INTERNAL_DOMAIN": {
"summary": "The email is not internal domain",
"description": "The email is not internal domain",
"value": {
"errors": [
{
"code": "ERR_NOT_INTERNAL_DOMAIN",
"message": "The email is not internal domain"
}
]
}
}
}
}
}
},
"413": {
"description": "Content Too Large
Possible error codes: ERR_SYSTEM_NO_STORAGE_AVAILABLE",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
},
"examples": {
"ERR_SYSTEM_NO_STORAGE_AVAILABLE": {
"summary": "Folder owner's remaining storage quota does not permit for a file upload of this size.",
"description": "Folder owner's remaining storage quota does not permit for a file upload of this size.",
"value": {
"errors": [
{
"code": "ERR_SYSTEM_NO_STORAGE_AVAILABLE",
"message": "Folder owner's remaining storage quota does not permit for a file upload of this size."
}
]
}
}
}
}
}
},
"422": {
"description": "Unprocessable Content
Possible error codes: ERR_INVALID_PARAMETER, ERR_CANNOT_RETAIN_DATA_TO_THE_SAME_USER, ERR_USER_IS_NOT_INTERNAL_DL_OR_INTERNAL_ACCOUNT, ERR_CANNOT_RETAIN_DATA_TO_UNVERIFIED_USER",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
},
"examples": {
"ERR_INVALID_PARAMETER": {
"summary": "Invalid Parameter Exception",
"description": "Invalid Parameter Exception",
"value": {
"errors": [
{
"code": "ERR_INVALID_PARAMETER",
"message": "Invalid Parameter Exception"
}
]
}
},
"ERR_CANNOT_RETAIN_DATA_TO_THE_SAME_USER": {
"summary": "Cannot retain data: selected user is being deleted/demoted. Please choose a different user.",
"description": "Cannot retain data: selected user is being deleted/demoted. Please choose a different user.",
"value": {
"errors": [
{
"code": "ERR_CANNOT_RETAIN_DATA_TO_THE_SAME_USER",
"message": "Cannot retain data: selected user is being deleted/demoted. Please choose a different user."
}
]
}
},
"ERR_USER_IS_NOT_INTERNAL_DL_OR_INTERNAL_ACCOUNT": {
"summary": "User is not internal distribution list or internal domain",
"description": "User is not internal distribution list or internal domain",
"value": {
"errors": [
{
"code": "ERR_USER_IS_NOT_INTERNAL_DL_OR_INTERNAL_ACCOUNT",
"message": "User is not internal distribution list or internal domain"
}
]
}
},
"ERR_CANNOT_RETAIN_DATA_TO_UNVERIFIED_USER": {
"summary": "Cannot retain data: selected user is unverified. Please select a verified user before proceeding.",
"description": "Cannot retain data: selected user is unverified. Please select a verified user before proceeding.",
"value": {
"errors": [
{
"code": "ERR_CANNOT_RETAIN_DATA_TO_UNVERIFIED_USER",
"message": "Cannot retain data: selected user is unverified. Please select a verified user before proceeding."
}
]
}
}
}
}
}
},
"490": {
"description": "Request blocked by WAF"
}
}
},
"get": {
"summary": "Return shared mailbox list",
"description": "### Description:\n Returns a paginated list of shared mailboxes, optionally filtered by user IDs.\n### Precondition:\n Caller must have system, application, or helpdesk admin role.\n### Response:\n A list of shared mailboxes is returned.\n",
"tags": [
"sharedMailbox"
],
"parameters": [
{
"in": "query",
"name": "orderBy",
"required": false,
"description": "Sort order for the results.
`modified:asc` \u2013 Sort by last modified date, ascending.
`modified:desc` \u2013 Sort by last modified date, descending.
`active:asc` \u2013 Sort by active status, ascending.
`active:desc` \u2013 Sort by active status, descending.",
"schema": {
"type": "string",
"enum": [
"modified:asc",
"modified:desc",
"active:asc",
"active:desc"
]
}
},
{
"in": "query",
"name": "limit",
"required": false,
"description": "Maximum number of results to return.",
"schema": {
"type": "integer",
"minimum": 1
}
},
{
"in": "query",
"name": "offset",
"required": false,
"description": "Number of results to skip before returning, for pagination.",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"in": "query",
"name": "active",
"required": false,
"description": "Filter by active status. If true, returns only active shared mailboxes; if false, returns only inactive ones.",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "id:in",
"required": false,
"explode": true,
"style": "form",
"description": "Comma-separated list of shared mailbox user UUIDs to filter by. (Recommended request size <= 100)",
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
}
],
"responses": {
"200": {
"description": "The shared mailboxes have been successfully returned.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SharedMailboxList"
}
}
}
},
"401": {
"description": "Unauthorized
Possible error codes: ERR_AUTH_INVALID_CSRF, ERR_AUTH_UNAUTHORIZED",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
},
"examples": {
"ERR_AUTH_INVALID_CSRF": {
"summary": "Invalid CSRF Authentication",
"description": "Invalid CSRF Authentication",
"value": {
"errors": [
{
"code": "ERR_AUTH_INVALID_CSRF",
"message": "Invalid CSRF Authentication"
}
]
}
},
"ERR_AUTH_UNAUTHORIZED": {
"summary": "Unauthorized",
"description": "Unauthorized",
"value": {
"errors": [
{
"code": "ERR_AUTH_UNAUTHORIZED",
"message": "Unauthorized"
}
]
}
}
}
}
}
},
"490": {
"description": "Request blocked by WAF"
}
}
},
"delete": {
"summary": "Delete shared mailboxes",
"description": "### Description:\n Deletes the specified shared mailboxes and restores the associated user accounts.\n### Precondition:\n Caller must have system, application, or helpdesk admin role.\n### Response:\n The shared mailboxes are deleted successfully.\n",
"tags": [
"sharedMailbox"
],
"parameters": [
{
"in": "query",
"name": "id:in",
"required": false,
"explode": true,
"style": "form",
"description": "Comma-separated list of shared mailbox user UUIDs to delete. (Recommended request size <= 100)",
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
}
],
"responses": {
"204": {
"description": "The shared mailboxes have been deleted successfully."
},
"401": {
"description": "Unauthorized
Possible error codes: ERR_AUTH_INVALID_CSRF, ERR_AUTH_UNAUTHORIZED, ERR_ENTITY_NOT_FOUND",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
},
"examples": {
"ERR_AUTH_INVALID_CSRF": {
"summary": "Invalid CSRF Authentication",
"description": "Invalid CSRF Authentication",
"value": {
"errors": [
{
"code": "ERR_AUTH_INVALID_CSRF",
"message": "Invalid CSRF Authentication"
}
]
}
},
"ERR_AUTH_UNAUTHORIZED": {
"summary": "Unauthorized",
"description": "Unauthorized",
"value": {
"errors": [
{
"code": "ERR_AUTH_UNAUTHORIZED",
"message": "Unauthorized"
}
]
}
},
"ERR_ENTITY_NOT_FOUND": {
"summary": "Entity does not exist",
"description": "Entity does not exist",
"value": {
"errors": [
{
"code": "ERR_ENTITY_NOT_FOUND",
"message": "Entity does not exist"
}
]
}
}
}
}
}
},
"403": {
"description": "Forbidden
Possible error codes: ERR_ACCESS_ADMIN, ERR_ACCESS_USER, ERR_ADMIN_ROLE_RANK_RESTRICTED, ERR_LICENSE_MAX_USERS_COUNT_REACHED",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
},
"examples": {
"ERR_ACCESS_ADMIN": {
"summary": "Insufficient admin access permissions",
"description": "Insufficient admin access permissions",
"value": {
"errors": [
{
"code": "ERR_ACCESS_ADMIN",
"message": "Insufficient admin access permissions"
}
]
}
},
"ERR_ACCESS_USER": {
"summary": "Insufficient access permissions",
"description": "Insufficient access permissions",
"value": {
"errors": [
{
"code": "ERR_ACCESS_USER",
"message": "Insufficient access permissions"
}
]
}
},
"ERR_ADMIN_ROLE_RANK_RESTRICTED": {
"summary": "Action is restricted due to admin role rank",
"description": "Action is restricted due to admin role rank",
"value": {
"errors": [
{
"code": "ERR_ADMIN_ROLE_RANK_RESTRICTED",
"message": "Action is restricted due to admin role rank"
}
]
}
},
"ERR_LICENSE_MAX_USERS_COUNT_REACHED": {
"summary": "License count has been reached",
"description": "License count has been reached",
"value": {
"errors": [
{
"code": "ERR_LICENSE_MAX_USERS_COUNT_REACHED",
"message": "License count has been reached"
}
]
}
}
}
}
}
},
"490": {
"description": "Request blocked by WAF"
}
}
}
},
"/rest/admin/sharedMailboxes/{id}": {
"patch": {
"summary": "Update shared mailbox members",
"description": "### Description:\n Updates the member list of the specified shared mailbox.\n### Precondition:\n Caller must have system, application, or helpdesk admin role.\n### Response:\n The shared mailbox is updated and its details are returned.\n",
"tags": [
"sharedMailbox"
],
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"description": "The unique identifier (UUID) of the user.",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SharedMailboxPatchRequest"
}
}
}
},
"responses": {
"200": {
"description": "The shared mailbox has been updated successfully.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SharedMailbox"
}
}
}
},
"401": {
"description": "Unauthorized
Possible error codes: ERR_AUTH_INVALID_CSRF, ERR_AUTH_UNAUTHORIZED",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
},
"examples": {
"ERR_AUTH_INVALID_CSRF": {
"summary": "Invalid CSRF Authentication",
"description": "Invalid CSRF Authentication",
"value": {
"errors": [
{
"code": "ERR_AUTH_INVALID_CSRF",
"message": "Invalid CSRF Authentication"
}
]
}
},
"ERR_AUTH_UNAUTHORIZED": {
"summary": "Unauthorized",
"description": "Unauthorized",
"value": {
"errors": [
{
"code": "ERR_AUTH_UNAUTHORIZED",
"message": "Unauthorized"
}
]
}
}
}
}
}
},
"403": {
"description": "Forbidden
Possible error codes: ERR_ACCESS_ADMIN, ERR_ACCESS_USER, ERR_ADMIN_ROLE_RANK_RESTRICTED, ERR_NOT_INTERNAL_DOMAIN",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
},
"examples": {
"ERR_ACCESS_ADMIN": {
"summary": "Insufficient admin access permissions",
"description": "Insufficient admin access permissions",
"value": {
"errors": [
{
"code": "ERR_ACCESS_ADMIN",
"message": "Insufficient admin access permissions"
}
]
}
},
"ERR_ACCESS_USER": {
"summary": "Insufficient access permissions",
"description": "Insufficient access permissions",
"value": {
"errors": [
{
"code": "ERR_ACCESS_USER",
"message": "Insufficient access permissions"
}
]
}
},
"ERR_ADMIN_ROLE_RANK_RESTRICTED": {
"summary": "Action is restricted due to admin role rank",
"description": "Action is restricted due to admin role rank",
"value": {
"errors": [
{
"code": "ERR_ADMIN_ROLE_RANK_RESTRICTED",
"message": "Action is restricted due to admin role rank"
}
]
}
},
"ERR_NOT_INTERNAL_DOMAIN": {
"summary": "The email is not internal domain",
"description": "The email is not internal domain",
"value": {
"errors": [
{
"code": "ERR_NOT_INTERNAL_DOMAIN",
"message": "The email is not internal domain"
}
]
}
}
}
}
}
},
"490": {
"description": "Request blocked by WAF"
}
}
}
},
"/rest/admin/cards": {
"get": {
"summary": "Get list of cards",
"description": "### Description:\n Returns the list of admin dashboard cards filtered by the specified card types.\n### Precondition:\n The user must be an administrator.\n### Response:\n Returns the list of cards matching the specified types.\n",
"tags": [
"cards"
],
"parameters": [
{
"in": "query",
"name": "type:in",
"required": true,
"explode": true,
"style": "form",
"description": "Comma-separated list of card types to retrieve.
`content_encryption` \u2013 Content encryption card.
`email_json_migration` \u2013 Email JSON migration card.
`system_security_scanning` \u2013 System security scanning card.
`events_table_monitor` \u2013 Events table monitor card.
`appadmin_db` \u2013 Application admin database card.
`sysadmin_db` \u2013 System admin database card.
`sysadmin_hosts` \u2013 System admin hosts card.
`epg_warnings` \u2013 EPG warnings card.
`safe_edit_server_health` \u2013 Safe edit server health card.",
"schema": {
"type": "array",
"enum": [
"content_encryption",
"email_json_migration",
"system_security_scanning",
"events_table_monitor",
"appadmin_db",
"sysadmin_db",
"sysadmin_hosts",
"epg_warnings",
"safe_edit_server_health"
],
"items": {
"type": "string"
}
}
}
],
"responses": {
"200": {
"description": "The list of cards has been successfully returned.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Card"
}
}
}
},
"401": {
"description": "Unauthorized
Possible error codes: ERR_AUTH_INVALID_CSRF, ERR_AUTH_UNAUTHORIZED",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
},
"examples": {
"ERR_AUTH_INVALID_CSRF": {
"summary": "Invalid CSRF Authentication",
"description": "Invalid CSRF Authentication",
"value": {
"errors": [
{
"code": "ERR_AUTH_INVALID_CSRF",
"message": "Invalid CSRF Authentication"
}
]
}
},
"ERR_AUTH_UNAUTHORIZED": {
"summary": "Unauthorized",
"description": "Unauthorized",
"value": {
"errors": [
{
"code": "ERR_AUTH_UNAUTHORIZED",
"message": "Unauthorized"
}
]
}
}
}
}
}
},
"403": {
"description": "Forbidden
Possible error codes: ERR_ACCESS_USER",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
},
"examples": {
"ERR_ACCESS_USER": {
"summary": "Insufficient access permissions",
"description": "Insufficient access permissions",
"value": {
"errors": [
{
"code": "ERR_ACCESS_USER",
"message": "Insufficient access permissions"
}
]
}
}
}
}
}
},
"422": {
"description": "Unprocessable Content
Possible error codes: ERR_INVALID_PARAMETER",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
},
"examples": {
"ERR_INVALID_PARAMETER": {
"summary": "Invalid Parameter Exception",
"description": "Invalid Parameter Exception",
"value": {
"errors": [
{
"code": "ERR_INVALID_PARAMETER",
"message": "Invalid Parameter Exception"
}
]
}
}
}
}
}
},
"490": {
"description": "Request blocked by WAF"
}
}
}
},
"/rest/admin/cards/details": {
"get": {
"summary": "Get card details",
"description": "### Description:\n Returns the detailed information for a specific admin dashboard card.\n### Precondition:\n The user must be an administrator with System or Application role.\n### Response:\n Returns the details of the specified card.\n",
"tags": [
"cards"
],
"parameters": [
{
"in": "query",
"name": "type",
"required": true,
"description": "The type of card to retrieve details for.
`content_encryption` \u2013 Content encryption card.
`email_json_migration` \u2013 Email JSON migration card.
`system_security_scanning` \u2013 System security scanning card.
`events_table_monitor` \u2013 Events table monitor card.
`appadmin_db` \u2013 Application admin database card.
`sysadmin_db` \u2013 System admin database card.
`sysadmin_hosts` \u2013 System admin hosts card.
`epg_warnings` \u2013 EPG warnings card.
`safe_edit_server_health` \u2013 Safe edit server health card.",
"schema": {
"type": "string",
"enum": [
"content_encryption",
"email_json_migration",
"system_security_scanning",
"events_table_monitor",
"appadmin_db",
"sysadmin_db",
"sysadmin_hosts",
"epg_warnings",
"safe_edit_server_health"
]
}
},
{
"in": "query",
"name": "hostId",
"required": false,
"description": "The unique identifier of the host to filter card data by.",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "volume",
"required": false,
"description": "Filter results to a specific storage volume.",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "storageType",
"required": false,
"description": "Filter results by storage type.
`user_files` \u2013 User file storage.
`replication_files` \u2013 Replication file storage.",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "limit",
"required": false,
"description": "Maximum number of error detail records to return. Error details are not returned if not set or set to 0.",
"schema": {
"type": "integer"
}
},
{
"in": "query",
"name": "offset",
"required": false,
"description": "Number of error detail records to skip before returning results, for pagination.",
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "The card details have been successfully returned.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Card"
}
}
}
},
"401": {
"description": "Unauthorized
Possible error codes: ERR_AUTH_INVALID_CSRF, ERR_AUTH_UNAUTHORIZED",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
},
"examples": {
"ERR_AUTH_INVALID_CSRF": {
"summary": "Invalid CSRF Authentication",
"description": "Invalid CSRF Authentication",
"value": {
"errors": [
{
"code": "ERR_AUTH_INVALID_CSRF",
"message": "Invalid CSRF Authentication"
}
]
}
},
"ERR_AUTH_UNAUTHORIZED": {
"summary": "Unauthorized",
"description": "Unauthorized",
"value": {
"errors": [
{
"code": "ERR_AUTH_UNAUTHORIZED",
"message": "Unauthorized"
}
]
}
}
}
}
}
},
"403": {
"description": "Forbidden
Possible error codes: ERR_ACCESS_USER",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
},
"examples": {
"ERR_ACCESS_USER": {
"summary": "Insufficient access permissions",
"description": "Insufficient access permissions",
"value": {
"errors": [
{
"code": "ERR_ACCESS_USER",
"message": "Insufficient access permissions"
}
]
}
}
}
}
}
},
"422": {
"description": "Unprocessable Content
Possible error codes: ERR_INVALID_PARAMETER",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
},
"examples": {
"ERR_INVALID_PARAMETER": {
"summary": "Invalid Parameter Exception",
"description": "Invalid Parameter Exception",
"value": {
"errors": [
{
"code": "ERR_INVALID_PARAMETER",
"message": "Invalid Parameter Exception"
}
]
}
}
}
}
}
},
"490": {
"description": "Request blocked by WAF"
}
}
}
},
"/rest/admin/cards/actions": {
"post": {
"summary": "Perform an action on a card",
"description": "### Description:\n Submits an action to perform on a specific admin dashboard card.\n### Precondition:\n The user must be an administrator with System or Application role.\n### Response:\n The action has been accepted and will be processed.\n",
"tags": [
"cards"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CardActionPostRequest"
}
}
}
},
"responses": {
"202": {
"description": "The action has been accepted and is being processed."
},
"401": {
"description": "Unauthorized
Possible error codes: ERR_AUTH_INVALID_CSRF, ERR_AUTH_UNAUTHORIZED",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
},
"examples": {
"ERR_AUTH_INVALID_CSRF": {
"summary": "Invalid CSRF Authentication",
"description": "Invalid CSRF Authentication",
"value": {
"errors": [
{
"code": "ERR_AUTH_INVALID_CSRF",
"message": "Invalid CSRF Authentication"
}
]
}
},
"ERR_AUTH_UNAUTHORIZED": {
"summary": "Unauthorized",
"description": "Unauthorized",
"value": {
"errors": [
{
"code": "ERR_AUTH_UNAUTHORIZED",
"message": "Unauthorized"
}
]
}
}
}
}
}
},
"403": {
"description": "Forbidden
Possible error codes: ERR_ACCESS_USER",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
},
"examples": {
"ERR_ACCESS_USER": {
"summary": "Insufficient access permissions",
"description": "Insufficient access permissions",
"value": {
"errors": [
{
"code": "ERR_ACCESS_USER",
"message": "Insufficient access permissions"
}
]
}
}
}
}
}
},
"404": {
"description": "Not Found
Possible error codes: ERR_ENTITY_NOT_FOUND",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
},
"examples": {
"ERR_ENTITY_NOT_FOUND": {
"summary": "Entity does not exist",
"description": "Entity does not exist",
"value": {
"errors": [
{
"code": "ERR_ENTITY_NOT_FOUND",
"message": "Entity does not exist"
}
]
}
}
}
}
}
},
"422": {
"description": "Unprocessable Content
Possible error codes: ERR_INVALID_PARAMETER",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
},
"examples": {
"ERR_INVALID_PARAMETER": {
"summary": "Invalid Parameter Exception",
"description": "Invalid Parameter Exception",
"value": {
"errors": [
{
"code": "ERR_INVALID_PARAMETER",
"message": "Invalid Parameter Exception"
}
]
}
}
}
}
}
},
"490": {
"description": "Request blocked by WAF"
}
}
}
},
"/rest/admin/files": {
"put": {
"summary": "Update files",
"description": "### Description:\n Updates the metadata of multiple files at the same time.\n### Precondition:\n Must be an administrator with access to the Files and Folders page in the Kiteworks PDN Admin.\n### Response:\n Updates the selected files.\n",
"tags": [
"files"
],
"parameters": [
{
"in": "query",
"name": "returnEntity",
"required": false,
"description": "If true, includes the entity in the response body.",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "with",
"required": false,
"description": "Specifies additional fields to include in the response.",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "mode",
"required": false,
"description": "Determines the detail level of the response body.",
"schema": {
"type": "string",
"enum": [
"compact",
"full_no_links",
"full_with_links",
"full"
]
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AdminFilePutRequest"
}
}
}
},
"responses": {
"200": {
"description": "The files have been successfully updated.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Files"
}
}
}
},
"401": {
"description": "Unauthorized
Possible error codes: ERR_AUTH_INVALID_CSRF, ERR_AUTH_UNAUTHORIZED",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
},
"examples": {
"ERR_AUTH_INVALID_CSRF": {
"summary": "Invalid CSRF Authentication",
"description": "Invalid CSRF Authentication",
"value": {
"errors": [
{
"code": "ERR_AUTH_INVALID_CSRF",
"message": "Invalid CSRF Authentication"
}
]
}
},
"ERR_AUTH_UNAUTHORIZED": {
"summary": "Unauthorized",
"description": "Unauthorized",
"value": {
"errors": [
{
"code": "ERR_AUTH_UNAUTHORIZED",
"message": "Unauthorized"
}
]
}
}
}
}
}
},
"403": {
"description": "Forbidden
Possible error codes: ERR_ACCESS_USER, ERR_ENTITY_DELETED, ERR_ENTITY_DLP_LOCKED, ERR_ENTITY_IS_ATTACHMENT, ERR_ENTITY_NOT_SCANNED, ERR_ENTITY_VIRUS_FOUND",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
},
"examples": {
"ERR_ACCESS_USER": {
"summary": "Insufficient access permissions",
"description": "Insufficient access permissions",
"value": {
"errors": [
{
"code": "ERR_ACCESS_USER",
"message": "Insufficient access permissions"
}
]
}
},
"ERR_ENTITY_DELETED": {
"summary": "Entity is deleted",
"description": "Entity is deleted",
"value": {
"errors": [
{
"code": "ERR_ENTITY_DELETED",
"message": "Entity is deleted"
}
]
}
},
"ERR_ENTITY_DLP_LOCKED": {
"summary": "One or more files have been quarantined and are not available to download. Please contact your administrator for assistance.",
"description": "One or more files have been quarantined and are not available to download. Please contact your administrator for assistance.",
"value": {
"errors": [
{
"code": "ERR_ENTITY_DLP_LOCKED",
"message": "One or more files have been quarantined and are not available to download. Please contact your administrator for assistance."
}
]
}
},
"ERR_ENTITY_IS_ATTACHMENT": {
"summary": "Operation not permitted on attachment",
"description": "Operation not permitted on attachment",
"value": {
"errors": [
{
"code": "ERR_ENTITY_IS_ATTACHMENT",
"message": "Operation not permitted on attachment"
}
]
}
},
"ERR_ENTITY_NOT_SCANNED": {
"summary": "One or more files are undergoing security and privacy scans. Please try again later.",
"description": "One or more files are undergoing security and privacy scans. Please try again later.",
"value": {
"errors": [
{
"code": "ERR_ENTITY_NOT_SCANNED",
"message": "One or more files are undergoing security and privacy scans. Please try again later."
}
]
}
},
"ERR_ENTITY_VIRUS_FOUND": {
"summary": "File is infected",
"description": "File is infected",
"value": {
"errors": [
{
"code": "ERR_ENTITY_VIRUS_FOUND",
"message": "File is infected"
}
]
}
}
}
}
}
},
"422": {
"description": "Unprocessable Content
Possible error codes: ERR_INPUT_EXCEEDS_MAX_VALUE, ERR_INPUT_PAST_DATE, ERR_INVALID_PARAMETER, ERR_SYSTEM_EXTEND_FILE_EXPIRATION_DISABLED",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
},
"examples": {
"ERR_INPUT_EXCEEDS_MAX_VALUE": {
"summary": "Field value exceeds maximum allowed value",
"description": "Field value exceeds maximum allowed value",
"value": {
"errors": [
{
"code": "ERR_INPUT_EXCEEDS_MAX_VALUE",
"message": "Field value exceeds maximum allowed value"
}
]
}
},
"ERR_INPUT_PAST_DATE": {
"summary": "Field value should be future date",
"description": "Field value should be future date",
"value": {
"errors": [
{
"code": "ERR_INPUT_PAST_DATE",
"message": "Field value should be future date"
}
]
}
},
"ERR_INVALID_PARAMETER": {
"summary": "Invalid Parameter Exception",
"description": "Invalid Parameter Exception",
"value": {
"errors": [
{
"code": "ERR_INVALID_PARAMETER",
"message": "Invalid Parameter Exception"
}
]
}
},
"ERR_SYSTEM_EXTEND_FILE_EXPIRATION_DISABLED": {
"summary": "Extending file expiration is not allowed",
"description": "Extending file expiration is not allowed",
"value": {
"errors": [
{
"code": "ERR_SYSTEM_EXTEND_FILE_EXPIRATION_DISABLED",
"message": "Extending file expiration is not allowed"
}
]
}
}
}
}
}
},
"490": {
"description": "Request blocked by WAF"
}
}
}
},
"/rest/admin/files/{id}/actions/rescan": {
"post": {
"summary": "Scan a file for security",
"description": "### Description:\n Runs a security scan on the specified file.\n### Precondition:\n Must authenticate as an administrator with a role allowing for manually scanning files for security.\n### Response:\n Scans the selected file for security. Depending on system scan policies, the file is scanned for anti-virus, data loss prevention, and advanced threat protection.\n",
"tags": [
"files"
],
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"description": "The unique identifier (UUID) of the entity.",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "query",
"name": "returnEntity",
"required": false,
"description": "If true, includes the entity in the response body.",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "with",
"required": false,
"description": "Specifies additional fields to include in the response.",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "mode",
"required": false,
"description": "Determines the detail level of the response body.",
"schema": {
"type": "string",
"enum": [
"compact",
"full_no_links",
"full_with_links",
"full"
]
}
}
],
"responses": {
"201": {
"description": "The file has been successfully submitted for rescan.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AdminFileRescan"
}
}
}
},
"401": {
"description": "Unauthorized
Possible error codes: ERR_AUTH_INVALID_CSRF, ERR_AUTH_UNAUTHORIZED",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
},
"examples": {
"ERR_AUTH_INVALID_CSRF": {
"summary": "Invalid CSRF Authentication",
"description": "Invalid CSRF Authentication",
"value": {
"errors": [
{
"code": "ERR_AUTH_INVALID_CSRF",
"message": "Invalid CSRF Authentication"
}
]
}
},
"ERR_AUTH_UNAUTHORIZED": {
"summary": "Unauthorized",
"description": "Unauthorized",
"value": {
"errors": [
{
"code": "ERR_AUTH_UNAUTHORIZED",
"message": "Unauthorized"
}
]
}
}
}
}
}
},
"403": {
"description": "Forbidden
Possible error codes: ERR_ACCESS_ADMIN",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
},
"examples": {
"ERR_ACCESS_ADMIN": {
"summary": "Insufficient admin access permissions",
"description": "Insufficient admin access permissions",
"value": {
"errors": [
{
"code": "ERR_ACCESS_ADMIN",
"message": "Insufficient admin access permissions"
}
]
}
}
}
}
}
},
"404": {
"description": "Not Found
Possible error codes: ERR_ENTITY_FILE_IS_NOT_FOUND, ERR_ENABLED_SCANNING_SERVICE_IS_NOT_FOUND",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
},
"examples": {
"ERR_ENTITY_FILE_IS_NOT_FOUND": {
"summary": "The file is not found",
"description": "The file is not found",
"value": {
"errors": [
{
"code": "ERR_ENTITY_FILE_IS_NOT_FOUND",
"message": "The file is not found"
}
]
}
},
"ERR_ENABLED_SCANNING_SERVICE_IS_NOT_FOUND": {
"summary": "No enabled scanning service is found",
"description": "No enabled scanning service is found",
"value": {
"errors": [
{
"code": "ERR_ENABLED_SCANNING_SERVICE_IS_NOT_FOUND",
"message": "No enabled scanning service is found"
}
]
}
}
}
}
}
},
"409": {
"description": "Conflict
Possible error codes: ERR_SCANNING_IN_PROGRESS",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
},
"examples": {
"ERR_SCANNING_IN_PROGRESS": {
"summary": "Scanning in progress. Please rescan later.",
"description": "Scanning in progress. Please rescan later.",
"value": {
"errors": [
{
"code": "ERR_SCANNING_IN_PROGRESS",
"message": "Scanning in progress. Please rescan later."
}
]
}
}
}
}
}
},
"422": {
"description": "Unprocessable Content
Possible error codes: ERR_INVALID_PARAMETER",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
},
"examples": {
"ERR_INVALID_PARAMETER": {
"summary": "Invalid Parameter Exception",
"description": "Invalid Parameter Exception",
"value": {
"errors": [
{
"code": "ERR_INVALID_PARAMETER",
"message": "Invalid Parameter Exception"
}
]
}
}
}
}
}
},
"490": {
"description": "Request blocked by WAF"
}
}
}
},
"/rest/admin/folders": {
"put": {
"summary": "Bulk update folders",
"description": "### Description:\n Updates multiple folders in a single request.\n### Precondition:\n The user must be an administrator with access to the Files and Folders page in the Kiteworks PDN Admin.\n### Response:\n The specified folders are updated.\n",
"tags": [
"folders"
],
"parameters": [
{
"in": "query",
"name": "returnEntity",
"required": false,
"description": "If true, includes the entity in the response body.",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "with",
"required": false,
"description": "Specifies additional fields to include in the response.",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "mode",
"required": false,
"description": "Determines the detail level of the response body.",
"schema": {
"type": "string",
"enum": [
"compact",
"full_no_links",
"full_with_links",
"full"
]
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AdminFolderPutRequest"
}
}
}
},
"responses": {
"200": {
"description": "Folders were updated successfully.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Folders"
}
}
}
},
"401": {
"description": "Unauthorized
Possible error codes: ERR_AUTH_INVALID_CSRF, ERR_AUTH_UNAUTHORIZED",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
},
"examples": {
"ERR_AUTH_INVALID_CSRF": {
"summary": "Invalid CSRF Authentication",
"description": "Invalid CSRF Authentication",
"value": {
"errors": [
{
"code": "ERR_AUTH_INVALID_CSRF",
"message": "Invalid CSRF Authentication"
}
]
}
},
"ERR_AUTH_UNAUTHORIZED": {
"summary": "Unauthorized",
"description": "Unauthorized",
"value": {
"errors": [
{
"code": "ERR_AUTH_UNAUTHORIZED",
"message": "Unauthorized"
}
]
}
}
}
}
}
},
"403": {
"description": "Forbidden
Possible error codes: ERR_ACCESS_USER, ERR_ENTITY_DELETED, ERR_ENTITY_DLP_LOCKED, ERR_ENTITY_IS_BASE_DIR, ERR_ENTITY_IS_MY_DIR, ERR_ENTITY_IS_SYNC_DIR, ERR_ENTITY_NOT_SCANNED, ERR_ENTITY_VIRUS_FOUND, ERR_PROFILE_COLLABORATION_DISABLED",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
},
"examples": {
"ERR_ACCESS_USER": {
"summary": "Insufficient access permissions",
"description": "Insufficient access permissions",
"value": {
"errors": [
{
"code": "ERR_ACCESS_USER",
"message": "Insufficient access permissions"
}
]
}
},
"ERR_ENTITY_DELETED": {
"summary": "Entity is deleted",
"description": "Entity is deleted",
"value": {
"errors": [
{
"code": "ERR_ENTITY_DELETED",
"message": "Entity is deleted"
}
]
}
},
"ERR_ENTITY_DLP_LOCKED": {
"summary": "One or more files have been quarantined and are not available to download. Please contact your administrator for assistance.",
"description": "One or more files have been quarantined and are not available to download. Please contact your administrator for assistance.",
"value": {
"errors": [
{
"code": "ERR_ENTITY_DLP_LOCKED",
"message": "One or more files have been quarantined and are not available to download. Please contact your administrator for assistance."
}
]
}
},
"ERR_ENTITY_IS_BASE_DIR": {
"summary": "Operation not permitted on Base Folder",
"description": "Operation not permitted on Base Folder",
"value": {
"errors": [
{
"code": "ERR_ENTITY_IS_BASE_DIR",
"message": "Operation not permitted on Base Folder"
}
]
}
},
"ERR_ENTITY_IS_MY_DIR": {
"summary": "Operation not permitted on Tray Folder",
"description": "Operation not permitted on Tray Folder",
"value": {
"errors": [
{
"code": "ERR_ENTITY_IS_MY_DIR",
"message": "Operation not permitted on Tray Folder"
}
]
}
},
"ERR_ENTITY_IS_SYNC_DIR": {
"summary": "Operation not permitted on My Folder",
"description": "Operation not permitted on My Folder",
"value": {
"errors": [
{
"code": "ERR_ENTITY_IS_SYNC_DIR",
"message": "Operation not permitted on My Folder"
}
]
}
},
"ERR_ENTITY_NOT_SCANNED": {
"summary": "One or more files are undergoing security and privacy scans. Please try again later.",
"description": "One or more files are undergoing security and privacy scans. Please try again later.",
"value": {
"errors": [
{
"code": "ERR_ENTITY_NOT_SCANNED",
"message": "One or more files are undergoing security and privacy scans. Please try again later."
}
]
}
},
"ERR_ENTITY_VIRUS_FOUND": {
"summary": "File is infected",
"description": "File is infected",
"value": {
"errors": [
{
"code": "ERR_ENTITY_VIRUS_FOUND",
"message": "File is infected"
}
]
}
},
"ERR_PROFILE_COLLABORATION_DISABLED": {
"summary": "User's profile has no collaboration access",
"description": "User's profile has no collaboration access",
"value": {
"errors": [
{
"code": "ERR_PROFILE_COLLABORATION_DISABLED",
"message": "User's profile has no collaboration access"
}
]
}
}
}
}
}
},
"422": {
"description": "Unprocessable Content
Possible error codes: ERR_INPUT_EXCEEDS_MAX_VALUE, ERR_INPUT_PAST_DATE, ERR_INVALID_PARAMETER, ERR_SYSTEM_EXTEND_FILE_EXPIRATION_DISABLED",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
},
"examples": {
"ERR_INPUT_EXCEEDS_MAX_VALUE": {
"summary": "Field value exceeds maximum allowed value",
"description": "Field value exceeds maximum allowed value",
"value": {
"errors": [
{
"code": "ERR_INPUT_EXCEEDS_MAX_VALUE",
"message": "Field value exceeds maximum allowed value"
}
]
}
},
"ERR_INPUT_PAST_DATE": {
"summary": "Field value should be future date",
"description": "Field value should be future date",
"value": {
"errors": [
{
"code": "ERR_INPUT_PAST_DATE",
"message": "Field value should be future date"
}
]
}
},
"ERR_INVALID_PARAMETER": {
"summary": "Invalid Parameter Exception",
"description": "Invalid Parameter Exception",
"value": {
"errors": [
{
"code": "ERR_INVALID_PARAMETER",
"message": "Invalid Parameter Exception"
}
]
}
},
"ERR_SYSTEM_EXTEND_FILE_EXPIRATION_DISABLED": {
"summary": "Extending file expiration is not allowed",
"description": "Extending file expiration is not allowed",
"value": {
"errors": [
{
"code": "ERR_SYSTEM_EXTEND_FILE_EXPIRATION_DISABLED",
"message": "Extending file expiration is not allowed"
}
]
}
}
}
}
}
},
"490": {
"description": "Request blocked by WAF"
}
}
}
},
"/rest/nodeHealth/{node_id}/metrics/{metric_name}": {
"get": {
"summary": "Get node health metrics for specified metric type",
"description": "### Description:\n Retrieves health metrics for database, web requests, job queue, SFTP, system resources, or all metrics.\n### Precondition:\n The user must be an administrator with access to `System Services`.\n### Response:\n Returns the list of metrics for the specified metric type.\n",
"tags": [
"system"
],
"parameters": [
{
"in": "path",
"name": "node_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Kiteworks node id to retrieve metrics from."
},
{
"in": "path",
"name": "metric_name",
"required": true,
"schema": {
"type": "string",
"enum": [
"kwDatabase",
"webRequests",
"jobqueued",
"sftp",
"systemResources",
"diskSpace",
"mailQueues",
"allMetrics"
]
},
"description": "The type of metric to retrieve."
}
],
"responses": {
"200": {
"description": "The node health metrics have been successfully returned.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NodeHealthMetricResponse"
}
}
}
},
"401": {
"description": "Unauthorized
Possible error codes: ERR_ACCESS_USER, ERR_AUTH_INVALID_CSRF, ERR_AUTH_UNAUTHORIZED",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
},
"examples": {
"ERR_ACCESS_USER": {
"summary": "Insufficient access permissions",
"description": "Insufficient access permissions",
"value": {
"errors": [
{
"code": "ERR_ACCESS_USER",
"message": "Insufficient access permissions"
}
]
}
},
"ERR_AUTH_INVALID_CSRF": {
"summary": "Invalid CSRF Authentication",
"description": "Invalid CSRF Authentication",
"value": {
"errors": [
{
"code": "ERR_AUTH_INVALID_CSRF",
"message": "Invalid CSRF Authentication"
}
]
}
},
"ERR_AUTH_UNAUTHORIZED": {
"summary": "Unauthorized",
"description": "Unauthorized",
"value": {
"errors": [
{
"code": "ERR_AUTH_UNAUTHORIZED",
"message": "Unauthorized"
}
]
}
}
}
}
}
},
"422": {
"description": "Unprocessable Content
Possible error codes: ERR_INVALID_PARAMETER",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
},
"examples": {
"ERR_INVALID_PARAMETER": {
"summary": "Invalid Parameter Exception",
"description": "Invalid Parameter Exception",
"value": {
"errors": [
{
"code": "ERR_INVALID_PARAMETER",
"message": "Invalid Parameter Exception"
}
]
}
}
}
}
}
},
"500": {
"description": "Internal Server Error
Possible error codes: ERR_INTERNAL_SERVER_ERROR",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
},
"examples": {
"ERR_INTERNAL_SERVER_ERROR": {
"summary": "Internal Server Error",
"description": "Internal Server Error",
"value": {
"errors": [
{
"code": "ERR_INTERNAL_SERVER_ERROR",
"message": "Internal Server Error"
}
]
}
}
}
}
}
},
"490": {
"description": "Request blocked by WAF"
}
}
}
},
"/rest/admin/users/actions/import": {
"post": {
"summary": "Bulk import users via CSV file",
"description": "### Overview:\n Import users in bulk using a CSV file.\n### Precondition:\n The user must be an administrator with access to `User Management`.\n### Response:\n The users will be either created or updated.\n",
"tags": [
"users"
],
"requestBody": {
"content": {
"multipart/form-data": {
"schema": {
"type": "object",
"properties": {
"content": {
"type": "string",
"format": "binary",
"description": "The CSV file containing the users to be imported."
},
"updateIfExists": {
"type": "boolean",
"description": "If true, existing users will be updated with the new settings."
},
"sendNotification": {
"type": "boolean",
"description": "If true, a notification email will be sent to each newly created user."
},
"partialSuccess": {
"type": "boolean",
"description": "If true, only validated users will be imported, while others will be rejected."
}
},
"required": [
"content"
]
}
}
}
},
"responses": {
"200": {
"description": "Users have been successfully imported.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AdminUserImport"
}
}
}
},
"401": {
"description": "Unauthorized
Possible error codes: ERR_AUTH_INVALID_CSRF, ERR_AUTH_UNAUTHORIZED",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
},
"examples": {
"ERR_AUTH_INVALID_CSRF": {
"summary": "Invalid CSRF Authentication",
"description": "Invalid CSRF Authentication",
"value": {
"errors": [
{
"code": "ERR_AUTH_INVALID_CSRF",
"message": "Invalid CSRF Authentication"
}
]
}
},
"ERR_AUTH_UNAUTHORIZED": {
"summary": "Unauthorized",
"description": "Unauthorized",
"value": {
"errors": [
{
"code": "ERR_AUTH_UNAUTHORIZED",
"message": "Unauthorized"
}
]
}
}
}
}
}
},
"403": {
"description": "Forbidden
Possible error codes: ERR_ACCESS_ADMIN",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
},
"examples": {
"ERR_ACCESS_ADMIN": {
"summary": "Insufficient admin access permissions",
"description": "Insufficient admin access permissions",
"value": {
"errors": [
{
"code": "ERR_ACCESS_ADMIN",
"message": "Insufficient admin access permissions"
}
]
}
}
}
}
}
},
"422": {
"description": "Unprocessable Content
Possible error codes: ERR_INPUT_INVALID_FORMAT, ERR_INVALID_ARGUMENT",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
},
"examples": {
"ERR_INPUT_INVALID_FORMAT": {
"summary": "The input is invalid.",
"description": "The input is invalid.",
"value": {
"errors": [
{
"code": "ERR_INPUT_INVALID_FORMAT",
"message": "The input is invalid."
}
]
}
},
"ERR_INVALID_ARGUMENT": {
"summary": "Invalid Argument",
"description": "Invalid Argument",
"value": {
"errors": [
{
"code": "ERR_INVALID_ARGUMENT",
"message": "Invalid Argument"
}
]
}
}
}
}
}
},
"490": {
"description": "Request blocked by WAF"
}
}
}
},
"/rest/admin/users/actions/deleteTotpSecret": {
"post": {
"summary": "Delete TOTP secrets for users",
"description": "### Description:\n Deletes the TOTP (Time-based One-Time Password) secret for the specified users.\n### Precondition:\n The user must be an administrator. The caller's admin role rank must be sufficient to manage the target users.\n### Response:\n The TOTP secrets for the specified users are deleted successfully.\n",
"tags": [
"users"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AdminDeleteTOTPSecretRequest"
}
}
}
},
"responses": {
"200": {
"description": "The TOTP secrets were deleted successfully."
},
"401": {
"description": "Unauthorized
Possible error codes: ERR_AUTH_INVALID_CSRF, ERR_AUTH_UNAUTHORIZED",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
},
"examples": {
"ERR_AUTH_INVALID_CSRF": {
"summary": "Invalid CSRF Authentication",
"description": "Invalid CSRF Authentication",
"value": {
"errors": [
{
"code": "ERR_AUTH_INVALID_CSRF",
"message": "Invalid CSRF Authentication"
}
]
}
},
"ERR_AUTH_UNAUTHORIZED": {
"summary": "Unauthorized",
"description": "Unauthorized",
"value": {
"errors": [
{
"code": "ERR_AUTH_UNAUTHORIZED",
"message": "Unauthorized"
}
]
}
}
}
}
}
},
"403": {
"description": "Forbidden
Possible error codes: ERR_ACCESS_ADMIN, ERR_ACCESS_USER, ERR_ADMIN_ROLE_RANK_RESTRICTED",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
},
"examples": {
"ERR_ACCESS_ADMIN": {
"summary": "Insufficient admin access permissions",
"description": "Insufficient admin access permissions",
"value": {
"errors": [
{
"code": "ERR_ACCESS_ADMIN",
"message": "Insufficient admin access permissions"
}
]
}
},
"ERR_ACCESS_USER": {
"summary": "Insufficient access permissions",
"description": "Insufficient access permissions",
"value": {
"errors": [
{
"code": "ERR_ACCESS_USER",
"message": "Insufficient access permissions"
}
]
}
},
"ERR_ADMIN_ROLE_RANK_RESTRICTED": {
"summary": "Action is restricted due to admin role rank",
"description": "Action is restricted due to admin role rank",
"value": {
"errors": [
{
"code": "ERR_ADMIN_ROLE_RANK_RESTRICTED",
"message": "Action is restricted due to admin role rank"
}
]
}
}
}
}
}
},
"404": {
"description": "Not Found
Possible error codes: ERR_ENTITY_NOT_FOUND",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
},
"examples": {
"ERR_ENTITY_NOT_FOUND": {
"summary": "Entity does not exist",
"description": "Entity does not exist",
"value": {
"errors": [
{
"code": "ERR_ENTITY_NOT_FOUND",
"message": "Entity does not exist"
}
]
}
}
}
}
}
},
"422": {
"description": "Unprocessable Content
Possible error codes: ERR_INPUT_INVALID_FORMAT",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
},
"examples": {
"ERR_INPUT_INVALID_FORMAT": {
"summary": "The input is invalid.",
"description": "The input is invalid.",
"value": {
"errors": [
{
"code": "ERR_INPUT_INVALID_FORMAT",
"message": "The input is invalid."
}
]
}
}
}
}
}
},
"490": {
"description": "Request blocked by WAF"
}
}
}
},
"/rest/admin/users/{id}/userSshPublicKeys": {
"get": {
"summary": "List SSH public keys for a user",
"description": "### Description:\n Returns all SSH public keys associated with the specified user.\n### Precondition:\n The user must be an administrator. SFTP must be enabled for the user's profile and system role.\n### Response:\n A list of SSH public keys for the specified user is returned.\n",
"tags": [
"userSshPublicKeys"
],
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"description": "The unique identifier (UUID) of the entity.",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "The list of SSH public keys was returned successfully.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AdminUserSshPublicKeyList"
}
}
}
},
"401": {
"description": "Unauthorized
Possible error codes: ERR_AUTH_INVALID_CSRF, ERR_AUTH_UNAUTHORIZED",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
},
"examples": {
"ERR_AUTH_INVALID_CSRF": {
"summary": "Invalid CSRF Authentication",
"description": "Invalid CSRF Authentication",
"value": {
"errors": [
{
"code": "ERR_AUTH_INVALID_CSRF",
"message": "Invalid CSRF Authentication"
}
]
}
},
"ERR_AUTH_UNAUTHORIZED": {
"summary": "Unauthorized",
"description": "Unauthorized",
"value": {
"errors": [
{
"code": "ERR_AUTH_UNAUTHORIZED",
"message": "Unauthorized"
}
]
}
}
}
}
}
},
"403": {
"description": "Forbidden
Possible error codes: ERR_ACCESS_USER, ERR_PROFILE_SFTP_DISABLED, ERR_SYSTEM_ROLE_SFTP_DISABLED",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
},
"examples": {
"ERR_ACCESS_USER": {
"summary": "Insufficient access permissions",
"description": "Insufficient access permissions",
"value": {
"errors": [
{
"code": "ERR_ACCESS_USER",
"message": "Insufficient access permissions"
}
]
}
},
"ERR_PROFILE_SFTP_DISABLED": {
"summary": "SFTP is not enabled for this profile",
"description": "SFTP is not enabled for this profile",
"value": {
"errors": [
{
"code": "ERR_PROFILE_SFTP_DISABLED",
"message": "SFTP is not enabled for this profile"
}
]
}
},
"ERR_SYSTEM_ROLE_SFTP_DISABLED": {
"summary": "SFTP role is not enabled on server",
"description": "SFTP role is not enabled on server",
"value": {
"errors": [
{
"code": "ERR_SYSTEM_ROLE_SFTP_DISABLED",
"message": "SFTP role is not enabled on server"
}
]
}
}
}
}
}
},
"490": {
"description": "Request blocked by WAF"
}
}
}
},
"/rest/admin/users/{id}/userSshPublicKeys/create": {
"post": {
"summary": "Create an SSH public key for a user",
"description": "### Description:\n Creates a new SSH public key record for the specified user using a provided public key string.\n### Precondition:\n The user must be an administrator. SFTP must be enabled for the user's profile and system role.\n### Response:\n The SSH public key record is created successfully.\n",
"tags": [
"userSshPublicKeys"
],
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"description": "The unique identifier (UUID) of the entity.",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UserSshPublicKeysPostCreateRequest"
}
}
}
},
"responses": {
"201": {
"description": "The SSH public key record was created successfully."
},
"401": {
"description": "Unauthorized
Possible error codes: ERR_AUTH_INVALID_CSRF, ERR_AUTH_UNAUTHORIZED",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
},
"examples": {
"ERR_AUTH_INVALID_CSRF": {
"summary": "Invalid CSRF Authentication",
"description": "Invalid CSRF Authentication",
"value": {
"errors": [
{
"code": "ERR_AUTH_INVALID_CSRF",
"message": "Invalid CSRF Authentication"
}
]
}
},
"ERR_AUTH_UNAUTHORIZED": {
"summary": "Unauthorized",
"description": "Unauthorized",
"value": {
"errors": [
{
"code": "ERR_AUTH_UNAUTHORIZED",
"message": "Unauthorized"
}
]
}
}
}
}
}
},
"403": {
"description": "Forbidden
Possible error codes: ERR_ACCESS_USER, ERR_PROFILE_SFTP_DISABLED, ERR_SYSTEM_ROLE_SFTP_DISABLED",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
},
"examples": {
"ERR_ACCESS_USER": {
"summary": "Insufficient access permissions",
"description": "Insufficient access permissions",
"value": {
"errors": [
{
"code": "ERR_ACCESS_USER",
"message": "Insufficient access permissions"
}
]
}
},
"ERR_PROFILE_SFTP_DISABLED": {
"summary": "SFTP is not enabled for this profile",
"description": "SFTP is not enabled for this profile",
"value": {
"errors": [
{
"code": "ERR_PROFILE_SFTP_DISABLED",
"message": "SFTP is not enabled for this profile"
}
]
}
},
"ERR_SYSTEM_ROLE_SFTP_DISABLED": {
"summary": "SFTP role is not enabled on server",
"description": "SFTP role is not enabled on server",
"value": {
"errors": [
{
"code": "ERR_SYSTEM_ROLE_SFTP_DISABLED",
"message": "SFTP role is not enabled on server"
}
]
}
}
}
}
}
},
"422": {
"description": "Unprocessable Content
Possible error codes: ERR_INVALID_PARAMETER, ERR_SSH_PUBLIC_KEY_EXISTS",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
},
"examples": {
"ERR_INVALID_PARAMETER": {
"summary": "Invalid Parameter Exception",
"description": "Invalid Parameter Exception",
"value": {
"errors": [
{
"code": "ERR_INVALID_PARAMETER",
"message": "Invalid Parameter Exception"
}
]
}
},
"ERR_SSH_PUBLIC_KEY_EXISTS": {
"summary": "Same ssh public key name exists",
"description": "Same ssh public key name exists",
"value": {
"errors": [
{
"code": "ERR_SSH_PUBLIC_KEY_EXISTS",
"message": "Same ssh public key name exists"
}
]
}
}
}
}
}
},
"490": {
"description": "Request blocked by WAF"
}
}
}
},
"/rest/admin/users/{id}/userSshPublicKeys/generate": {
"post": {
"summary": "Generate an SSH key pair for a user",
"description": "### Description:\n Generates a new SSH public/private key pair for the specified user and stores the public key.\n### Precondition:\n The user must be an administrator. SFTP must be enabled for the user's profile and system role.\n### Response:\n The newly generated public/private key pair is returned.\n",
"tags": [
"userSshPublicKeys"
],
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"description": "The unique identifier (UUID) of the entity.",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UserSshPublicKeysPostGenerateRequest"
}
}
}
},
"responses": {
"201": {
"description": "The SSH key pair was generated successfully.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UserGeneratedSshPublicKeyKey"
}
}
}
},
"401": {
"description": "Unauthorized
Possible error codes: ERR_AUTH_INVALID_CSRF, ERR_AUTH_UNAUTHORIZED",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
},
"examples": {
"ERR_AUTH_INVALID_CSRF": {
"summary": "Invalid CSRF Authentication",
"description": "Invalid CSRF Authentication",
"value": {
"errors": [
{
"code": "ERR_AUTH_INVALID_CSRF",
"message": "Invalid CSRF Authentication"
}
]
}
},
"ERR_AUTH_UNAUTHORIZED": {
"summary": "Unauthorized",
"description": "Unauthorized",
"value": {
"errors": [
{
"code": "ERR_AUTH_UNAUTHORIZED",
"message": "Unauthorized"
}
]
}
}
}
}
}
},
"403": {
"description": "Forbidden
Possible error codes: ERR_ACCESS_USER, ERR_PROFILE_SFTP_DISABLED, ERR_SYSTEM_ROLE_SFTP_DISABLED",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
},
"examples": {
"ERR_ACCESS_USER": {
"summary": "Insufficient access permissions",
"description": "Insufficient access permissions",
"value": {
"errors": [
{
"code": "ERR_ACCESS_USER",
"message": "Insufficient access permissions"
}
]
}
},
"ERR_PROFILE_SFTP_DISABLED": {
"summary": "SFTP is not enabled for this profile",
"description": "SFTP is not enabled for this profile",
"value": {
"errors": [
{
"code": "ERR_PROFILE_SFTP_DISABLED",
"message": "SFTP is not enabled for this profile"
}
]
}
},
"ERR_SYSTEM_ROLE_SFTP_DISABLED": {
"summary": "SFTP role is not enabled on server",
"description": "SFTP role is not enabled on server",
"value": {
"errors": [
{
"code": "ERR_SYSTEM_ROLE_SFTP_DISABLED",
"message": "SFTP role is not enabled on server"
}
]
}
}
}
}
}
},
"422": {
"description": "Unprocessable Content
Possible error codes: ERR_INVALID_PARAMETER, ERR_SSH_PUBLIC_KEY_EXISTS",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
},
"examples": {
"ERR_INVALID_PARAMETER": {
"summary": "Invalid Parameter Exception",
"description": "Invalid Parameter Exception",
"value": {
"errors": [
{
"code": "ERR_INVALID_PARAMETER",
"message": "Invalid Parameter Exception"
}
]
}
},
"ERR_SSH_PUBLIC_KEY_EXISTS": {
"summary": "Same ssh public key name exists",
"description": "Same ssh public key name exists",
"value": {
"errors": [
{
"code": "ERR_SSH_PUBLIC_KEY_EXISTS",
"message": "Same ssh public key name exists"
}
]
}
}
}
}
}
},
"490": {
"description": "Request blocked by WAF"
}
}
}
},
"/{host_name}/rest/uploads/{id}": {
"post": {
"summary": "Upload a file chunk",
"description": "### Description:\n Uploads a single chunk of a file to the server using the upload link obtained from an initiate-upload call. The file is reconstructed server-side once all chunks are received.\n### Precondition:\n * The caller must hold a valid upload link.\n * The client must split the file into chunks before uploading.\n * Chunks must be uploaded sequentially, starting from index 1.\n### Response:\n Returns the updated upload session after each intermediate chunk, and the completed file record after the final chunk.\n",
"tags": [
"uploads"
],
"parameters": [
{
"in": "path",
"name": "host_name",
"required": true,
"description": "The upload host name, which can be retrieved from GET /uploads/{id} or the initiateUpload response.",
"schema": {
"type": "string"
}
},
{
"in": "path",
"name": "id",
"required": true,
"description": "The unique identifier of the upload.",
"schema": {
"type": "integer"
}
},
{
"in": "query",
"name": "returnEntity",
"required": false,
"description": "If true, includes the entity in the response body.",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "with",
"required": false,
"description": "Specifies additional fields to include in the response.",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "mode",
"required": false,
"description": "Determines the detail level of the response body.",
"schema": {
"type": "string",
"enum": [
"compact",
"full_no_links",
"full_with_links",
"full"
]
}
}
],
"requestBody": {
"content": {
"multipart/form-data": {
"schema": {
"type": "object",
"properties": {
"compressionMode": {
"type": "string",
"description": "The compression mode used for the chunk. Options include \"NORMAL\", \"GZIP\", and \"ZLIB\".",
"enum": [
"NORMAL",
"GZIP",
"ZLIB"
]
},
"compressionSize": {
"type": "integer",
"format": "int64",
"description": "The size of the chunk after compression."
},
"originalSize": {
"type": "integer",
"format": "int64",
"description": "The size of the chunk before compression."
},
"content": {
"type": "string",
"format": "binary",
"description": "The binary content of the chunk."
},
"index": {
"type": "integer",
"format": "int64",
"description": "The sequential index of the chunk (starts from 1)."
},
"lastChunk": {
"type": "integer",
"format": "int64",
"description": "Indicates if this is the last chunk of the file (1 if last, 0 otherwise)."
}
},
"required": [
"compressionMode",
"compressionSize",
"originalSize",
"content"
]
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/BaseChunkUploadRequest"
}
}
}
},
"responses": {
"200": {
"description": "The current chunk upload is successfully received but not yet registered to the server.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Upload"
}
}
}
},
"201": {
"description": "File uploaded successfully and is registered to the server after the last chunk is received.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/File"
}
}
}
},
"400": {
"description": "Bad Request
Possible error codes: ERR_REQUEST_INVALID_JSON",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
},
"examples": {
"ERR_REQUEST_INVALID_JSON": {
"summary": "Invalid json provided",
"description": "Invalid json provided",
"value": {
"errors": [
{
"code": "ERR_REQUEST_INVALID_JSON",
"message": "Invalid json provided"
}
]
}
}
}
}
}
},
"401": {
"description": "Unauthorized
Possible error codes: ERR_AUTH_INVALID_CSRF, ERR_AUTH_UNAUTHORIZED",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
},
"examples": {
"ERR_AUTH_INVALID_CSRF": {
"summary": "Invalid CSRF Authentication",
"description": "Invalid CSRF Authentication",
"value": {
"errors": [
{
"code": "ERR_AUTH_INVALID_CSRF",
"message": "Invalid CSRF Authentication"
}
]
}
},
"ERR_AUTH_UNAUTHORIZED": {
"summary": "Unauthorized",
"description": "Unauthorized",
"value": {
"errors": [
{
"code": "ERR_AUTH_UNAUTHORIZED",
"message": "Unauthorized"
}
]
}
}
}
}
}
},
"403": {
"description": "Forbidden
Possible error codes: ERR_ACCESS_USER, ERR_ENTITY_DLP_LOCKED, ERR_ENTITY_IS_BASE_DIR, ERR_ENTITY_NOT_SCANNED, ERR_ENTITY_REQUEST_FILE_UPLOAD_LIMIT_REACHED, ERR_ENTITY_RESTRICTED_TYPE, ERR_ENTITY_VIRUS_FOUND",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
},
"examples": {
"ERR_ACCESS_USER": {
"summary": "Insufficient access permissions",
"description": "Insufficient access permissions",
"value": {
"errors": [
{
"code": "ERR_ACCESS_USER",
"message": "Insufficient access permissions"
}
]
}
},
"ERR_ENTITY_DLP_LOCKED": {
"summary": "One or more files have been quarantined and are not available to download. Please contact your administrator for assistance.",
"description": "One or more files have been quarantined and are not available to download. Please contact your administrator for assistance.",
"value": {
"errors": [
{
"code": "ERR_ENTITY_DLP_LOCKED",
"message": "One or more files have been quarantined and are not available to download. Please contact your administrator for assistance."
}
]
}
},
"ERR_ENTITY_IS_BASE_DIR": {
"summary": "Operation not permitted on Base Folder",
"description": "Operation not permitted on Base Folder",
"value": {
"errors": [
{
"code": "ERR_ENTITY_IS_BASE_DIR",
"message": "Operation not permitted on Base Folder"
}
]
}
},
"ERR_ENTITY_NOT_SCANNED": {
"summary": "One or more files are undergoing security and privacy scans. Please try again later.",
"description": "One or more files are undergoing security and privacy scans. Please try again later.",
"value": {
"errors": [
{
"code": "ERR_ENTITY_NOT_SCANNED",
"message": "One or more files are undergoing security and privacy scans. Please try again later."
}
]
}
},
"ERR_ENTITY_REQUEST_FILE_UPLOAD_LIMIT_REACHED": {
"summary": "Upload limit has reached.",
"description": "Upload limit has reached.",
"value": {
"errors": [
{
"code": "ERR_ENTITY_REQUEST_FILE_UPLOAD_LIMIT_REACHED",
"message": "Upload limit has reached."
}
]
}
},
"ERR_ENTITY_RESTRICTED_TYPE": {
"summary": "The specified entity mime type is not allowed.",
"description": "The specified entity mime type is not allowed.",
"value": {
"errors": [
{
"code": "ERR_ENTITY_RESTRICTED_TYPE",
"message": "The specified entity mime type is not allowed."
}
]
}
},
"ERR_ENTITY_VIRUS_FOUND": {
"summary": "File is infected",
"description": "File is infected",
"value": {
"errors": [
{
"code": "ERR_ENTITY_VIRUS_FOUND",
"message": "File is infected"
}
]
}
}
}
}
}
},
"422": {
"description": "Unprocessable Content
Possible error codes: ERR_INPUT_NOT_IN_LIST, ERR_INVALID_PARAMETER, ERR_LICENSE_MAX_UPLOAD_SIZE",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
},
"examples": {
"ERR_INPUT_NOT_IN_LIST": {
"summary": "The specified input is not allowed.",
"description": "The specified input is not allowed.",
"value": {
"errors": [
{
"code": "ERR_INPUT_NOT_IN_LIST",
"message": "The specified input is not allowed."
}
]
}
},
"ERR_INVALID_PARAMETER": {
"summary": "Invalid Parameter Exception",
"description": "Invalid Parameter Exception",
"value": {
"errors": [
{
"code": "ERR_INVALID_PARAMETER",
"message": "Invalid Parameter Exception"
}
]
}
},
"ERR_LICENSE_MAX_UPLOAD_SIZE": {
"summary": "Upload size exceed licensed maximum upload size",
"description": "Upload size exceed licensed maximum upload size",
"value": {
"errors": [
{
"code": "ERR_LICENSE_MAX_UPLOAD_SIZE",
"message": "Upload size exceed licensed maximum upload size"
}
]
}
}
}
}
}
},
"490": {
"description": "Request blocked by WAF"
}
}
}
}
},
"components": {
"schemas": {
"FileNameRequest.Post": {
"properties": {
"fileType": {
"description": "The file type",
"type": "string"
},
"fileName": {
"description": "The file name",
"type": "string"
}
}
},
"FileNameRequest.Put": {
"properties": {
"fileType": {
"description": "The file type",
"type": "string"
},
"fileName": {
"description": "The file name",
"type": "string"
}
}
},
"MemberBase": {
"description": "Class MemberBase",
"required": [
"objectId",
"roleId"
],
"properties": {
"objectId": {
"description": "Unique identifier of the folder this member belongs to",
"type": "string"
},
"roleId": {
"description": "Unique identifier of the role assigned to this member",
"type": "integer"
},
"user": {
"description": "Details of the user who is a member (Explicit field. May be retrieved only if mentioned in \"with\" parameter)",
"$ref": "#/components/schemas/User"
},
"group": {
"description": "Details of the LDAP group that is a member (Explicit field. May be retrieved only if mentioned in \"with\" parameter)",
"$ref": "#/components/schemas/LdapGroup"
},
"role": {
"description": "Details of the role assigned to this member (Explicit field. May be retrieved only if mentioned in \"with\" parameter)",
"$ref": "#/components/schemas/Role"
},
"inheritRoleId": {
"description": "Unique identifier of the role inherited from the parent folder (Explicit field. May be retrieved only if mentioned in \"with\" parameter)",
"type": "integer"
},
"allowedFolderRoleId": {
"description": "List of role identifiers that are permitted for this folder membership (Explicit field. May be retrieved only if mentioned in \"with\" parameter)",
"type": "array",
"items": {
"type": "string"
}
},
"links": {
"description": "HATEOAS links associated with the entity",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"MemberBase.Post": {
"description": "Class MemberBase",
"required": [
"roleId"
],
"properties": {
"roleId": {
"description": "Unique identifier of the role to assign to this member",
"type": "integer"
},
"addLinks": {
"description": "Indicates whether HATEOAS links should be included in the response",
"type": "boolean"
}
}
},
"MemberBase.Put": {
"description": "Class MemberBase",
"required": [
"roleId"
],
"properties": {
"roleId": {
"description": "Unique identifier of the role to assign to this member",
"type": "integer"
},
"notifyFileAdded": {
"description": "Indicates whether the member should be notified when a file is added",
"type": "boolean"
},
"addLinks": {
"description": "Indicates whether HATEOAS links should be included in the response",
"type": "boolean"
}
}
},
"EmailAccountLockedJob": {
"properties": {
"id": {
"description": "Job unique identifier",
"type": "string"
},
"status": {
"description": "Current job status. Accepted values: `queued`, `working`, `succeeded`, `failed`",
"type": "string"
},
"errors": {
"description": "List of errors that occurred during job processing",
"type": "string"
},
"objectIds": {
"description": "List of object IDs associated with this job",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"Client": {
"description": "Class Client",
"required": [
"id",
"name"
],
"properties": {
"id": {
"description": "Unique Client identifier",
"type": "string"
},
"name": {
"description": "Display name of the client application",
"type": "string"
},
"description": {
"description": "Human-readable description of the client application and its purpose",
"type": "string"
},
"redirectUri": {
"description": "Redirect URL of this client",
"type": "string"
},
"scope": {
"description": "API entities which this client can access",
"type": "string"
},
"flag": {
"description": "Flags for Client. e.g. NO_CONSENT:1, DISABLED:2, HIDDEN:4, NO_EXPIRY_TOKEN :8",
"type": "integer"
},
"flow": {
"description": "Oauth flow for this client.\n e.g. AUTH_CODE:1, CLIENT_CREDENTIAL:2, SIGNATURE:4, REFRESH_TOKEN:8",
"type": "integer"
},
"signatureKey": {
"description": "Secret key used to sign requests made by this client",
"type": "string"
},
"accessTokenLifetime": {
"description": "Life time for access token of client in hours. e.g. 5=5 hours",
"type": "integer"
},
"refreshTokenLifetime": {
"description": "Life time for refresh token of client in hours",
"type": "integer"
},
"whiteList": {
"description": "List of applications on the device that the client can call out to",
"type": "string"
},
"askPin": {
"description": "Indicates whether a PIN should be requested of the user using this client",
"type": "integer"
},
"pinTimeout": {
"description": "Time out for pin of client in minutes",
"type": "integer"
},
"maxPinAttempts": {
"description": "Max attempts that user can try to enter PIN before wipe occurs",
"type": "integer"
},
"type": {
"description": "Client Type. e.g. ACCELLION:1, MOBILE:2, OUTLOOK:4, SYNC:8, IMPORTED:32",
"type": "integer"
},
"touchId": {
"description": "Indicates whether touch Id is enabled",
"type": "boolean"
},
"clipboardEnabled": {
"description": "Indicates whether clipboard is enabled",
"type": "boolean"
},
"autoUpdate": {
"description": "Indicates whether auto update is enabled",
"type": "boolean"
},
"installer": {
"description": "Installer information for the client",
"type": "string"
},
"emailMatch": {
"description": "Indicates whether the external email matches a Kiteworks email",
"type": "boolean"
},
"minVersion": {
"description": "Minimum API version required by this client to operate correctly",
"type": "integer"
},
"links": {
"description": "HATEOAS links associated with the entity",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"Client.Post": {
"description": "Class Client",
"required": [
"name",
"description",
"redirectUri",
"scope"
],
"properties": {
"name": {
"description": "Display name of the client application",
"type": "string"
},
"description": {
"description": "Human-readable description of the client application and its purpose",
"type": "string"
},
"redirectUri": {
"description": "Where the server send the code that client can redeem access token.\n e.g. https://HOST/rest/callback.html",
"type": "string"
},
"scope": {
"description": "API entities which this client can access",
"type": "string"
},
"signatureKey": {
"description": "Secret key used to sign requests made by this client",
"type": "string"
},
"accessTokenLifetime": {
"description": "Life time for access token of client in hours. e.g. 5=5 hours",
"type": "integer"
},
"refreshTokenLifetime": {
"description": "Life time for refresh token of client in hours",
"type": "integer"
},
"addLinks": {
"description": "Indicates whether HATEOAS links should be included in the response",
"type": "boolean"
}
}
},
"Client.Put": {
"description": "Class Client",
"required": [
"name",
"description",
"redirectUri",
"scope"
],
"properties": {
"name": {
"description": "Display name of the client application",
"type": "string"
},
"description": {
"description": "Human-readable description of the client application and its purpose",
"type": "string"
},
"redirectUri": {
"description": "Where the server send the code that client can redeem access token.\n e.g. https://HOST/rest/callback.html",
"type": "string"
},
"scope": {
"description": "API entities which this client can access",
"type": "string"
},
"signatureKey": {
"description": "Secret key used to sign requests made by this client",
"type": "string"
},
"accessTokenLifetime": {
"description": "Life time for access token of client in hours. e.g. 5=5 hours",
"type": "integer"
},
"refreshTokenLifetime": {
"description": "Life time for refresh token of client in hours",
"type": "integer"
},
"addLinks": {
"description": "Indicates whether HATEOAS links should be included in the response",
"type": "boolean"
}
}
},
"EmailReturnReceipt": {
"description": "Class Recipient",
"required": [
"mailId",
"userId"
],
"properties": {
"mailId": {
"description": "Email unique identifier for return receipt",
"type": "integer"
},
"user": {
"description": "User who is associated with this return receipt record",
"$ref": "#/components/schemas/UserBasicInfo"
},
"userId": {
"description": "User ID for Return Receipt",
"type": "string"
}
}
},
"EmailReturnReceipt.Post": {
"description": "Class Recipient",
"required": [
"userId"
],
"properties": {
"userId": {
"description": "User ID for Return Receipt",
"type": "integer"
}
}
},
"EmailReturnReceipt.Put": {
"description": "Class Recipient",
"required": [
"userId"
],
"properties": {
"userId": {
"description": "User ID for Return Receipt",
"type": "integer"
}
}
},
"BaseObject": {
"description": "Class Object",
"required": [
"id",
"name",
"parentId",
"userId"
],
"properties": {
"id": {
"description": "Unique identifier of object",
"type": "string"
},
"created": {
"description": "Date and time when the object was created",
"type": "string",
"format": "date-time"
},
"deleted": {
"description": "Indicates whether the object is deleted",
"type": "boolean"
},
"permDeleted": {
"description": "Indicates whether the object is permanently deleted",
"type": "boolean"
},
"expire": {
"description": "Date and time when the object expires and becomes inaccessible",
"type": "string",
"format": "date-time"
},
"modified": {
"description": "Date and time when the object was last modified",
"type": "string",
"format": "date-time"
},
"name": {
"description": "Display name of the object",
"type": "string"
},
"parentId": {
"description": "Parent Folder identifier",
"type": "string"
},
"userId": {
"description": "Unique identifier of Object creator",
"type": "string"
},
"parent": {
"description": "Folder that directly contains this object (Explicit field. May be retrieved only if mentioned in \"with\" parameter)",
"$ref": "#/components/schemas/Folder"
},
"permalink": {
"description": "Permanent URL for accessing the object in the web application",
"type": "string"
},
"creator": {
"description": "Basic profile information of the user who created the object (Explicit field. May be retrieved only if mentioned in \"with\" parameter)",
"$ref": "#/components/schemas/UserBasicInfo"
},
"permissions": {
"description": "Current user's permissions (Explicit field. May be retrieved only if mentioned in \"with\" parameter)",
"type": "array",
"items": {
"$ref": "#/components/schemas/Permission"
}
},
"vendorDocId": {
"description": "Identifier of the corresponding document in the external vendor system (Explicit field. May be retrieved only if mentioned in \"with\" parameter)",
"type": "string"
},
"vendorDocName": {
"description": "Display name of the corresponding document in the external vendor system (Explicit field. May be retrieved only if mentioned in \"with\" parameter)",
"type": "string"
},
"source": {
"description": "Numeric code identifying the external system that originated this object (e.g. Salesforce, Teams)",
"type": "integer"
},
"links": {
"description": "HATEOAS links associated with the entity",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"BaseObject.Post": {
"description": "Class Object",
"properties": {
"addLinks": {
"description": "Indicates whether HATEOAS links should be included in the response",
"type": "boolean"
}
}
},
"BaseObject.Put": {
"description": "Class Object",
"properties": {
"addLinks": {
"description": "Indicates whether HATEOAS links should be included in the response",
"type": "boolean"
}
}
},
"CloudSourceLogin.Post": {
"description": "Class CloudSourceLogin",
"required": [
"code",
"state"
],
"properties": {
"client": {
"description": "ID of the client, from redirect url",
"type": "string"
},
"code": {
"description": "Code from redirect url",
"type": "string"
},
"state": {
"description": "Anti-CSRF state token returned by the OAuth provider in the redirect URL",
"type": "string"
},
"sessionState": {
"description": "Optional field needed for SharePoint Online and OneDrive",
"type": "string"
}
}
},
"CloudSourceLogin.Put": {
"description": "Class CloudSourceLogin",
"required": [
"code",
"state"
],
"properties": {
"client": {
"description": "ID of the client, from redirect url",
"type": "string"
},
"code": {
"description": "Code from redirect url",
"type": "string"
},
"state": {
"description": "Anti-CSRF state token returned by the OAuth provider in the redirect URL",
"type": "string"
},
"sessionState": {
"description": "Optional field needed for SharePoint Online and OneDrive",
"type": "string"
}
}
},
"SyncedObject": {
"type": "object",
"properties": {
"objectId": {
"type": "string",
"description": "Unique identifier (UUID) for the synced object."
},
"userId": {
"type": "string",
"description": "Unique identifier (UUID) for the user who synced the object."
},
"created": {
"type": "string",
"format": "date",
"description": "The date and time when the object was pushed."
},
"user": {
"description": "Details of the user who pushed the object.",
"allOf": [
{
"$ref": "#/components/schemas/UserBasic"
}
]
}
}
},
"Upload": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "Unique identifier for the upload."
},
"userId": {
"type": "string",
"description": "Unique identifier of the user who initiated the upload."
},
"timestamp": {
"type": "string",
"format": "date",
"description": "Timestamp when the upload was initiated."
},
"totalSize": {
"type": "integer",
"description": "Total size of the uploaded file in bytes."
},
"totalChunks": {
"type": "integer",
"description": "Total number of chunks the file was split into."
},
"clientName": {
"type": "string",
"description": "Name of the client uploading the file."
},
"svrUploadTime": {
"type": "integer",
"description": "Time taken by the server to process the upload (in milliseconds)."
},
"uploadedSize": {
"type": "integer",
"description": "Total size of the uploaded chunks in bytes."
},
"lastTimestamp": {
"type": "string",
"format": "date",
"description": "Timestamp of the last uploaded chunk."
},
"error": {
"type": "string",
"description": "Error message in case of upload failure."
},
"uri": {
"readOnly": true,
"description": "The URI for the upload link."
},
"completeOk": {
"type": "integer",
"description": "Flag indicating if the upload was completed successfully (1 for success, 0 otherwise)."
},
"fileUrl": {
"type": "string",
"description": "URL where the uploaded file can be accessed."
},
"replaceId": {
"type": "string",
"description": "ID of the file being replaced, if applicable."
},
"backend": {
"type": "string",
"description": "Backend storage system used for the upload."
},
"finished": {
"type": "boolean",
"description": "Indicates whether the upload process has finished."
},
"clientCreated": {
"type": "string",
"format": "date",
"description": "Timestamp when the file was created on the client side."
},
"clientModified": {
"type": "string",
"format": "date",
"description": "Timestamp when the file was last modified on the client side."
},
"requestFileId": {
"type": "integer",
"description": "ID of the file request associated with the upload."
},
"emailId": {
"type": "integer",
"description": "ID of the email associated with the uploaded file, if applicable."
},
"uploadedChunks": {
"type": "integer",
"description": "Number of chunks successfully uploaded."
},
"location": {
"type": "string",
"description": "The logical storage location of the uploaded file."
},
"uploadUrl": {
"readOnly": true,
"description": "The complete URL for the upload link."
}
}
},
"Upload.Post": {
"description": "Class FileUpload",
"required": [
"filename"
],
"properties": {
"filename": {
"description": "Name of the file being uploaded",
"type": "string"
},
"totalSize": {
"description": "Total file size in bytes",
"type": "integer"
},
"totalChunks": {
"description": "Total number of chunks the file is split into for upload",
"type": "integer"
},
"clientCreated": {
"description": "File creation date set from client",
"type": "string",
"format": "date"
},
"clientModified": {
"description": "File modify date set from client",
"type": "string",
"format": "date"
},
"disableAutoVersion": {
"description": "Indicates whether Client would like to save file as new version",
"type": "boolean"
}
}
},
"Upload.Put": {
"description": "Class FileUpload",
"properties": {
"disableAutoVersion": {
"description": "Indicates whether Client would like to save file as new version",
"type": "boolean"
}
}
},
"RequestFileUpload": {
"description": "Class RequestFileUpload",
"properties": {
"fileId": {
"description": "The unique identifier of the uploaded file",
"type": "string"
},
"requestFileId": {
"description": "The unique identifier of the associated request file",
"type": "integer"
}
}
},
"GroupNotification": {
"description": "Class Notification",
"properties": {
"objectId": {
"description": "Unique identifier of the folder included in the notification",
"type": "string"
},
"fileAdded": {
"description": "Number of files added to the notification",
"type": "integer"
},
"commentAdded": {
"description": "Number of comments added to the notification",
"type": "integer"
},
"links": {
"description": "HATEOAS links associated with the entity",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"GroupNotification.Post": {
"description": "Class Notification",
"properties": {
"fileAdded": {
"description": "Number of files added to the notification",
"type": "integer"
},
"commentAdded": {
"description": "Number of comments added to the notification",
"type": "integer"
},
"addLinks": {
"description": "Indicates whether HATEOAS links should be included in the response",
"type": "boolean"
}
}
},
"GroupNotification.Put": {
"description": "Class Notification",
"properties": {
"fileAdded": {
"description": "Number of files added to the notification",
"type": "integer"
},
"commentAdded": {
"description": "Number of comments added to the notification",
"type": "integer"
},
"addLinks": {
"description": "Indicates whether HATEOAS links should be included in the response",
"type": "boolean"
}
}
},
"OtpRecipient": {
"description": "Class OtpRecipient",
"required": [
"email",
"type",
"userId"
],
"properties": {
"userId": {
"description": "Recipient user unique identifier",
"type": "string"
},
"type": {
"description": "Recipient type. Accepted values: `0` (TO), `1` (CC), `2` (BCC)",
"type": "integer"
},
"user": {
"description": "Basic profile information for the recipient user (Explicit field. May be retrieved only if mentioned in \"with\" parameter)",
"$ref": "#/components/schemas/UserBasicInfo"
},
"email": {
"description": "Recipient email address",
"type": "string"
},
"isDistributionList": {
"description": "Indicates whether the recipient is a distribution list",
"type": "boolean"
},
"links": {
"description": "HATEOAS links associated with the entity",
"type": "array",
"items": {
"type": "string"
}
},
"mobileNumber": {
"description": "Recipient mobile number",
"type": "string"
}
}
},
"OtpRecipient.Post": {
"description": "Class OtpRecipient",
"required": [
"userId"
],
"properties": {
"userId": {
"description": "Recipient user unique identifier",
"type": "integer"
},
"type": {
"description": "Recipient type. Accepted values: `0` (TO), `1` (CC), `2` (BCC)",
"type": "integer",
"enum": [
"0",
"1",
"2"
]
},
"read": {
"description": "Indicates whether the email has been read",
"type": "boolean"
},
"addLinks": {
"description": "Indicates whether HATEOAS links should be included in the response",
"type": "boolean"
}
}
},
"OtpRecipient.Put": {
"description": "Class OtpRecipient",
"required": [
"userId"
],
"properties": {
"userId": {
"description": "Recipient user unique identifier",
"type": "integer"
},
"addLinks": {
"description": "Indicates whether HATEOAS links should be included in the response",
"type": "boolean"
}
}
},
"Contact": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "Unique identifier of the contact."
},
"userId": {
"type": "string"
},
"name": {
"type": "string",
"description": "Display name of the contact."
},
"created": {
"type": "string",
"format": "date",
"description": "Date and time when the contact was created."
},
"modified": {
"type": "string",
"format": "date",
"description": "Date and time when the contact was last modified."
},
"lastContactDate": {
"type": "string",
"format": "date",
"description": "Date and time of the most recent interaction with this contact."
},
"items": {
"type": "array",
"description": "List of email addresses or distribution lists for this contact.",
"items": {
"$ref": "#/components/schemas/ContactItem"
}
}
}
},
"Contact.Post": {
"description": "Class Contact",
"required": [
"items",
"name"
],
"properties": {
"name": {
"description": "Display name of the contact or group",
"type": "string"
},
"items": {
"description": "List of email addresses contained in the contact",
"type": "array",
"items": {
"$ref": "#/components/schemas/ContactItem.Post"
}
},
"addLinks": {
"description": "Indicates whether HATEOAS links should be included in the response",
"type": "boolean"
}
}
},
"Contact.Put": {
"description": "Class Contact",
"required": [
"items",
"name"
],
"properties": {
"name": {
"description": "Display name of the contact or group",
"type": "string"
},
"items": {
"description": "List of email addresses contained in the contact",
"type": "array",
"items": {
"$ref": "#/components/schemas/ContactItem.Post"
}
},
"addLinks": {
"description": "Indicates whether HATEOAS links should be included in the response",
"type": "boolean"
}
}
},
"DailyStorage": {
"description": "Class Storage",
"properties": {
"dateTime": {
"description": "Storage measurement date",
"type": "string",
"format": "date"
},
"usage": {
"description": "Storage usage in bytes",
"type": "integer"
}
}
},
"PopulateSftpUsernamesJob": {
"properties": {
"id": {
"description": "Job unique identifier",
"type": "string"
},
"status": {
"description": "Current job status. Accepted values: `queued`, `working`, `succeeded`, `failed`",
"type": "string"
},
"errors": {
"description": "List of errors that occurred during job processing",
"type": "string"
},
"objectIds": {
"description": "List of object IDs associated with this job",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"KitepointPreview": {
"description": "Class Preview",
"properties": {
"viewUrl": {
"description": "URL for viewing the rendered preview of the file in a browser",
"type": "string"
},
"status": {
"description": "Preview status. Accepted values: `Processing`, `Preview`, `Failed`",
"type": "string"
},
"static": {
"description": "URL for accessing the static (non-interactive) preview image of the file",
"type": "string"
},
"rawUrl": {
"description": "URL for downloading the raw preview content directly",
"type": "string"
}
}
},
"SiteConfiguration": {
"description": "Class SiteConfiguration",
"properties": {
"id": {
"description": "Site configuration unique identifier",
"type": "integer"
},
"attributeName": {
"description": "Name of the site configuration attribute identifying the setting",
"type": "string"
},
"value": {
"description": "Value of the site configuration attribute",
"type": "string"
}
}
},
"KPTransferStatus": {
"description": "Class KPTransferStatus",
"required": [
"errCode",
"fileHandle",
"id",
"kPObjectId",
"transactionId",
"userId"
],
"properties": {
"id": {
"description": "KP transfer status unique identifier",
"type": "string"
},
"transactionId": {
"description": "Unique transaction identifier for tracking the Repositories Gateway file transfer",
"type": "string"
},
"kPObjectId": {
"description": "Unique identifier of the Repositories Gateway object being transferred",
"type": "string"
},
"fileHandle": {
"description": "File handle used to reference the temporary file during the transfer process",
"type": "string"
},
"userId": {
"description": "The unique identifier of the user.",
"type": "string"
},
"errCode": {
"description": "Numeric error code returned when the file transfer fails",
"type": "string"
},
"status": {
"description": "Current status of the Repositories Gateway file transfer. Accepted values: `0` (received request), `1` (in progress), `2` (completed successfully), `99` (transfer failed)",
"type": "string"
},
"avStatus": {
"description": "AV scan status. Accepted values: `allowed`, `disallowed`, `scanning`",
"type": "string"
},
"dlpStatus": {
"description": "DLP scan status. Accepted values: `allowed`, `disallowed`, `scanning`",
"type": "string"
}
}
},
"AcfsConfig": {
"description": "Class AcfsConfig",
"properties": {
"acfsDbname": {
"description": "ACFS database name",
"type": "string"
},
"active": {
"description": "Indicates whether the upload server is active",
"type": "integer"
},
"message": {
"description": "ACFS status message",
"type": "string"
},
"minReplication": {
"description": "Minimum replication factor required for data stored on this ACFS node",
"type": "string"
},
"uploadChunkMax": {
"description": "Maximum size of a single upload chunk in bytes",
"type": "integer"
},
"uploadTimeout": {
"description": "Upload timeout in seconds",
"type": "integer"
},
"uploadWipe": {
"description": "Indicates whether uploaded data is wiped from temporary storage after processing",
"type": "integer"
}
}
},
"EmailFile": {
"description": "Class EmailFile",
"required": [
"id",
"locked",
"name",
"parentId",
"size",
"type",
"userId",
"wopiapp"
],
"properties": {
"id": {
"description": "Unique identifier of object",
"type": "string"
},
"created": {
"description": "Date and time when the object was created",
"type": "string",
"format": "date-time"
},
"deleted": {
"description": "Indicates whether the object is deleted",
"type": "boolean"
},
"permDeleted": {
"description": "Indicates whether the object is permanently deleted",
"type": "boolean"
},
"expire": {
"description": "Date and time when the object expires and becomes inaccessible",
"type": "string",
"format": "date-time"
},
"modified": {
"description": "Date and time when the object was last modified",
"type": "string",
"format": "date-time"
},
"name": {
"description": "Display name of the object",
"type": "string"
},
"parentId": {
"description": "Parent Folder identifier",
"type": "string"
},
"userId": {
"description": "Unique identifier of Object creator",
"type": "string"
},
"parent": {
"description": "Folder that directly contains this object (Explicit field. May be retrieved only if mentioned in \"with\" parameter)",
"$ref": "#/components/schemas/Folder"
},
"permalink": {
"description": "Permanent URL for accessing the object in the web application",
"type": "string"
},
"creator": {
"description": "Basic profile information of the user who created the object (Explicit field. May be retrieved only if mentioned in \"with\" parameter)",
"$ref": "#/components/schemas/UserBasicInfo"
},
"permissions": {
"description": "Current user's permissions (Explicit field. May be retrieved only if mentioned in \"with\" parameter)",
"type": "array",
"items": {
"$ref": "#/components/schemas/Permission"
}
},
"vendorDocId": {
"description": "Identifier of the corresponding document in the external vendor system (Explicit field. May be retrieved only if mentioned in \"with\" parameter)",
"type": "string"
},
"vendorDocName": {
"description": "Display name of the corresponding document in the external vendor system (Explicit field. May be retrieved only if mentioned in \"with\" parameter)",
"type": "string"
},
"source": {
"description": "Numeric code identifying the external system that originated this object (e.g. Salesforce, Teams)",
"type": "integer"
},
"links": {
"description": "HATEOAS links associated with the entity",
"type": "array",
"items": {
"type": "string"
}
},
"mime": {
"description": "File MIME type",
"type": "string"
},
"size": {
"description": "Size of the file content in bytes",
"type": "string"
},
"fingerprint": {
"description": "Cryptographic fingerprint (hash) of the file content used for integrity verification",
"type": "string"
},
"tracking_id": {
"description": "File tracking ID (UUID)",
"type": "string"
},
"type": {
"type": "string"
},
"locked": {
"description": "Unique identifier of User who locked a File",
"type": "integer"
},
"lockUser": {
"description": "User who locked the File (Explicit field. May be retrieved only if mentioned in \"with\" parameter)",
"$ref": "#/components/schemas/User"
},
"clientCreated": {
"description": "Original created time of the file",
"type": "string",
"format": "date"
},
"clientModified": {
"description": "Original modified time of the file",
"type": "string",
"format": "date"
},
"members": {
"description": "File members list (Explicit field. May be retrieved only if mentioned in \"with\" parameter)",
"type": "array",
"items": {
"$ref": "#/components/schemas/Member"
}
},
"overriddenExpire": {
"description": "Indicates whether the file expiration date is overridden",
"type": "boolean"
},
"originalFileId": {
"description": "File identifier from which this file was copied from",
"type": "string"
},
"pushedObject": {
"description": "Contains pushedObject data if current file was ever pushed (Explicit field. May be retrieved only if mentioned in \"with\" parameter)",
"$ref": "#/components/schemas/PushedObject"
},
"avStatus": {
"description": "Check file availability status according to AV settings and file scanned/infected status",
"type": "string"
},
"dlpStatus": {
"description": "Check file availability status according to DLP settings and file scanned/infected status",
"type": "string"
},
"adminQuarantineStatus": {
"description": "Check file availability status according to admin quarantined status",
"type": "string"
},
"storageAvailable": {
"description": "Boolean value that shows if this file is available on any volume",
"type": "boolean"
},
"lastModifiedBy": {
"description": "Creator of the latest version (Explicit field. May be retrieved only if mentioned in \"with\" parameter)",
"$ref": "#/components/schemas/User"
},
"wopiapp": {
"description": "WOPI info for iOS app",
"type": "boolean"
},
"roleId": {
"description": "Highest role of the current user on this file",
"type": "string"
},
"isShared": {
"description": "Indicates whether the file is shared",
"type": "string"
},
"fingerprints": {
"description": "Array of file fingerprint objects",
"type": "array",
"items": {
"type": "string"
}
},
"tags": {
"description": "Array of tag objects",
"type": "array",
"items": {
"$ref": "#/components/schemas/Tag"
}
}
}
},
"EmailFile.Post": {
"description": "Class EmailFile",
"required": [
"name"
],
"properties": {
"addLinks": {
"description": "Indicates whether HATEOAS links should be included in the response",
"type": "boolean"
},
"name": {
"description": "Display name of the file",
"type": "string"
}
}
},
"EmailFile.Put": {
"description": "Class EmailFile",
"required": [
"name"
],
"properties": {
"addLinks": {
"description": "Indicates whether HATEOAS links should be included in the response",
"type": "boolean"
},
"name": {
"description": "Display name of the file",
"type": "string"
},
"expire": {
"description": "The file expiration date.",
"type": "string"
},
"replace": {
"description": "Replace the file if file with same name exists",
"type": "string"
}
}
},
"ActivitiesWithdrawUserFilesJob": {
"properties": {
"id": {
"description": "Job unique identifier",
"type": "string"
},
"status": {
"description": "Current job status. Accepted values: `queued`, `working`, `succeeded`, `failed`",
"type": "string"
},
"errors": {
"description": "List of errors that occurred during job processing",
"type": "string"
},
"objectIds": {
"description": "List of object IDs associated with this job",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"CopyToEcJob": {
"properties": {
"id": {
"description": "Job unique identifier",
"type": "string"
},
"status": {
"description": "Current job status. Accepted values: `queued`, `working`, `succeeded`, `failed`",
"type": "string"
},
"errors": {
"description": "List of errors that occurred during job processing",
"type": "string"
},
"objectIds": {
"description": "List of object IDs associated with this job",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"PushedObject": {
"type": "object",
"properties": {
"objectId": {
"type": "string",
"description": "Unique identifier (UUID) for the pushed object."
},
"userId": {
"type": "string",
"description": "Unique identifier (UUID) for the user who pushed the object."
},
"created": {
"type": "string",
"format": "date",
"description": "The date and time when the object was pushed."
},
"user": {
"description": "Details of the user who pushed the object.",
"allOf": [
{
"$ref": "#/components/schemas/UserBasic"
}
]
}
}
},
"WebForm": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique identifier of the web form."
},
"lastModified": {
"type": "string",
"format": "date",
"description": "Date and time when the web form was last modified."
},
"name": {
"type": "string",
"description": "Display name of the web form."
},
"description": {
"type": "string",
"description": "Description of the web form."
},
"url": {
"type": "string",
"description": "URL where the web form is accessible."
},
"enabled": {
"type": "boolean",
"description": "Indicates whether the web form is active."
},
"authRequired": {
"type": "boolean",
"description": "Indicates whether authentication is required to submit the web form."
},
"embedded": {
"type": "boolean",
"description": "Indicates whether the web form can be embedded in external pages."
},
"standalone": {
"type": "boolean",
"description": "Indicates whether the web form can be used as a standalone page."
},
"profiles": {
"description": "List of user profiles that have access to this web form.",
"type": "array",
"items": {
"$ref": "#/components/schemas/WebFormProfile"
}
},
"fields": {
"description": "List of fields in the web form.",
"type": "array",
"items": {
"$ref": "#/components/schemas/WebFormField"
}
}
}
},
"WebForm.Post": {
"description": "Class WebForm",
"properties": {
"addLinks": {
"description": "Indicates whether HATEOAS links should be included in the response",
"type": "boolean"
}
}
},
"WebForm.Put": {
"description": "Class WebForm",
"properties": {
"addLinks": {
"description": "Indicates whether HATEOAS links should be included in the response",
"type": "boolean"
}
}
},
"AvailableLdapGroup": {
"description": "Class LdapGroup",
"properties": {
"name": {
"description": "Display name of the LDAP group",
"type": "string"
},
"dn": {
"description": "LDAP group distinguished name",
"type": "string"
}
}
},
"UserNotification": {
"description": "Class Notification",
"required": [
"userId"
],
"properties": {
"objectId": {
"description": "Unique identifier of the folder included in the notification",
"type": "string"
},
"fileAdded": {
"description": "Number of files added to the notification",
"type": "integer"
},
"commentAdded": {
"description": "Number of comments added to the notification",
"type": "integer"
},
"links": {
"description": "HATEOAS links associated with the entity",
"type": "array",
"items": {
"type": "string"
}
},
"userId": {
"description": "Unique identifier of the user who receives the notification",
"type": "string"
}
}
},
"UserNotification.Post": {
"description": "Class Notification",
"properties": {
"fileAdded": {
"description": "Number of files added to the notification",
"type": "integer"
},
"commentAdded": {
"description": "Number of comments added to the notification",
"type": "integer"
},
"addLinks": {
"description": "Indicates whether HATEOAS links should be included in the response",
"type": "boolean"
}
}
},
"UserNotification.Put": {
"description": "Class Notification",
"properties": {
"fileAdded": {
"description": "Number of files added to the notification",
"type": "integer"
},
"commentAdded": {
"description": "Number of comments added to the notification",
"type": "integer"
},
"addLinks": {
"description": "Indicates whether HATEOAS links should be included in the response",
"type": "boolean"
}
}
},
"WebFormField": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique identifier of the web form field."
},
"sequence": {
"type": "integer",
"description": "Display order of the field within the form."
},
"label": {
"type": "string",
"description": "Display label of the field."
},
"type": {
"type": "string",
"description": "Input type of the field (e.g., text, select, checkbox)."
},
"specialType": {
"type": "string",
"description": "Special processing type for the field, if applicable."
},
"placeholder": {
"type": "string",
"description": "Placeholder text shown in the field before input."
},
"defaultValue": {
"type": "string",
"description": "Default value pre-populated in the field."
},
"optionValues": {
"type": "string",
"description": "Available option values for select-type fields."
},
"mandatory": {
"type": "boolean",
"description": "Indicates whether the field is required."
},
"editable": {
"type": "boolean",
"description": "Indicates whether the field can be edited by the user."
}
}
},
"Group": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "LDAP Group ID"
},
"name": {
"type": "string",
"description": "LDAP Group name"
},
"dn": {
"type": "string",
"description": "LDAP Group domain name"
},
"email": {
"type": "string",
"description": "LDAP Group email"
},
"description": {
"type": "string",
"description": "LDAP Group description"
}
}
},
"Group.Post": {
"description": "Class Group",
"required": [
"items",
"name"
],
"properties": {
"name": {
"description": "Display name of the contact or group",
"type": "string"
},
"items": {
"description": "List of email addresses contained in the contact",
"type": "array",
"items": {
"$ref": "#/components/schemas/ContactItem.Post"
}
},
"addLinks": {
"description": "Indicates whether HATEOAS links should be included in the response",
"type": "boolean"
}
}
},
"Group.Put": {
"description": "Class Group",
"required": [
"items",
"name"
],
"properties": {
"name": {
"description": "Display name of the contact or group",
"type": "string"
},
"items": {
"description": "List of email addresses contained in the contact",
"type": "array",
"items": {
"$ref": "#/components/schemas/ContactItem.Post"
}
},
"addLinks": {
"description": "Indicates whether HATEOAS links should be included in the response",
"type": "boolean"
}
}
},
"UserAdminRole": {
"description": "Class UserAdminRole",
"required": [
"userId"
],
"properties": {
"userId": {
"description": "User unique identifier",
"type": "string"
},
"adminRole": {
"description": "Admin role unique identifier. Possible values are: 1: System admin, 2: Application admin",
"type": "string"
}
}
},
"UserAdminRole.Post": {
"description": "Class UserAdminRole",
"properties": {
"userId": {
"description": "User unique identifier",
"type": "integer"
},
"adminRole": {
"description": "Admin role unique identifier. Possible values are: 1: System admin, 2: Application admin",
"type": "string"
}
}
},
"UserAdminRole.Put": {
"description": "Class UserAdminRole",
"properties": {
"userId": {
"description": "User unique identifier",
"type": "integer"
},
"adminRole": {
"description": "Admin role unique identifier. Possible values are: 1: System admin, 2: Application admin",
"type": "string"
}
}
},
"Link": {
"description": "Class LinkEntity",
"properties": {
"rel": {
"description": "Link relation type",
"type": "string"
},
"entity": {
"description": "Entity name the link points to",
"type": "string"
},
"id": {
"description": "Entity unique identifier",
"type": "integer"
},
"href": {
"description": "Full URL of the linked resource",
"type": "string"
}
}
},
"Content": {
"description": "Class Content",
"required": [
"id",
"locked",
"name",
"parentId",
"size",
"type",
"userId",
"wopiapp"
],
"properties": {
"id": {
"description": "Unique identifier of object",
"type": "string"
},
"created": {
"description": "Date and time when the object was created",
"type": "string",
"format": "date-time"
},
"deleted": {
"description": "Indicates whether the object is deleted",
"type": "boolean"
},
"permDeleted": {
"description": "Indicates whether the object is permanently deleted",
"type": "boolean"
},
"expire": {
"description": "Date and time when the object expires and becomes inaccessible",
"type": "string",
"format": "date-time"
},
"modified": {
"description": "Date and time when the object was last modified",
"type": "string",
"format": "date-time"
},
"name": {
"description": "Display name of the object",
"type": "string"
},
"parentId": {
"description": "Parent Folder identifier",
"type": "string"
},
"userId": {
"description": "Unique identifier of Object creator",
"type": "string"
},
"parent": {
"description": "Folder that directly contains this object (Explicit field. May be retrieved only if mentioned in \"with\" parameter)",
"$ref": "#/components/schemas/Folder"
},
"permalink": {
"description": "Permanent URL for accessing the object in the web application",
"type": "string"
},
"creator": {
"description": "Basic profile information of the user who created the object (Explicit field. May be retrieved only if mentioned in \"with\" parameter)",
"$ref": "#/components/schemas/UserBasicInfo"
},
"permissions": {
"description": "Current user's permissions (Explicit field. May be retrieved only if mentioned in \"with\" parameter)",
"type": "array",
"items": {
"$ref": "#/components/schemas/Permission"
}
},
"vendorDocId": {
"description": "Identifier of the corresponding document in the external vendor system (Explicit field. May be retrieved only if mentioned in \"with\" parameter)",
"type": "string"
},
"vendorDocName": {
"description": "Display name of the corresponding document in the external vendor system (Explicit field. May be retrieved only if mentioned in \"with\" parameter)",
"type": "string"
},
"source": {
"description": "Numeric code identifying the external system that originated this object (e.g. Salesforce, Teams)",
"type": "integer"
},
"links": {
"description": "HATEOAS links associated with the entity",
"type": "array",
"items": {
"type": "string"
}
},
"mime": {
"description": "File MIME type",
"type": "string"
},
"size": {
"description": "Size of the file content in bytes",
"type": "string"
},
"fingerprint": {
"description": "Cryptographic fingerprint (hash) of the file content used for integrity verification",
"type": "string"
},
"tracking_id": {
"description": "File tracking ID (UUID)",
"type": "string"
},
"type": {
"type": "string"
},
"locked": {
"description": "Unique identifier of User who locked a File",
"type": "integer"
},
"lockUser": {
"description": "User who locked the File (Explicit field. May be retrieved only if mentioned in \"with\" parameter)",
"$ref": "#/components/schemas/User"
},
"clientCreated": {
"description": "Original created time of the file",
"type": "string",
"format": "date"
},
"clientModified": {
"description": "Original modified time of the file",
"type": "string",
"format": "date"
},
"members": {
"description": "File members list (Explicit field. May be retrieved only if mentioned in \"with\" parameter)",
"type": "array",
"items": {
"$ref": "#/components/schemas/Member"
}
},
"overriddenExpire": {
"description": "Indicates whether the file expiration date is overridden",
"type": "boolean"
},
"originalFileId": {
"description": "File identifier from which this file was copied from",
"type": "string"
},
"pushedObject": {
"description": "Contains pushedObject data if current file was ever pushed (Explicit field. May be retrieved only if mentioned in \"with\" parameter)",
"$ref": "#/components/schemas/PushedObject"
},
"avStatus": {
"description": "Check file availability status according to AV settings and file scanned/infected status",
"type": "string"
},
"dlpStatus": {
"description": "Check file availability status according to DLP settings and file scanned/infected status",
"type": "string"
},
"adminQuarantineStatus": {
"description": "Check file availability status according to admin quarantined status",
"type": "string"
},
"storageAvailable": {
"description": "Boolean value that shows if this file is available on any volume",
"type": "boolean"
},
"lastModifiedBy": {
"description": "Creator of the latest version (Explicit field. May be retrieved only if mentioned in \"with\" parameter)",
"$ref": "#/components/schemas/User"
},
"wopiapp": {
"description": "WOPI info for iOS app",
"type": "boolean"
},
"roleId": {
"description": "Highest role of the current user on this file",
"type": "string"
},
"isShared": {
"description": "Indicates whether the file is shared",
"type": "string"
},
"fingerprints": {
"description": "Array of file fingerprint objects",
"type": "array",
"items": {
"type": "string"
}
},
"tags": {
"description": "Array of tag objects",
"type": "array",
"items": {
"$ref": "#/components/schemas/Tag"
}
}
}
},
"Content.Post": {
"description": "Class Content",
"required": [
"content",
"name"
],
"properties": {
"addLinks": {
"description": "Indicates whether HATEOAS links should be included in the response",
"type": "boolean"
},
"name": {
"description": "Display name of the file",
"type": "string"
},
"content": {
"description": "Raw content body of the file being created",
"type": "string"
},
"clientCreated": {
"description": "Date and time when the file was created on the client side",
"type": "integer"
},
"clientModified": {
"description": "Date and time when the file was last modified on the client side",
"type": "integer"
},
"note": {
"description": "Indicates whether the file should be uploaded as a note",
"type": "integer"
},
"disableAutoVersion": {
"description": "Indicates whether the file should be prevented from being saved as a new version",
"type": "boolean"
}
}
},
"Content.Put": {
"description": "Class Content",
"required": [
"name"
],
"properties": {
"addLinks": {
"description": "Indicates whether HATEOAS links should be included in the response",
"type": "boolean"
},
"name": {
"description": "Display name of the file",
"type": "string"
},
"expire": {
"description": "The file expiration date.",
"type": "string"
},
"replace": {
"description": "Replace the file if file with same name exists",
"type": "string"
},
"clientCreated": {
"description": "Date and time when the file was created on the client side",
"type": "integer"
},
"clientModified": {
"description": "Date and time when the file was last modified on the client side",
"type": "integer"
},
"note": {
"description": "Indicates whether the file should be uploaded as a note",
"type": "integer"
},
"disableAutoVersion": {
"description": "Indicates whether the file should be prevented from being saved as a new version",
"type": "boolean"
}
}
},
"ContactBase": {
"description": "Class ContactBase",
"required": [
"id",
"name",
"userId"
],
"properties": {
"id": {
"description": "Contact unique identifier",
"type": "integer"
},
"userId": {
"description": "Contact owner unique identifier",
"type": "string"
},
"name": {
"description": "Display name of the contact or group",
"type": "string"
},
"modified": {
"description": "Date and time when the contact was last modified",
"type": "string",
"format": "date"
},
"created": {
"description": "Date and time when the contact was created",
"type": "string",
"format": "date"
},
"items": {
"description": "List of email addresses contained in the contact",
"type": "array",
"items": {
"$ref": "#/components/schemas/ContactItem"
}
},
"links": {
"description": "HATEOAS links associated with the entity",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"ContactBase.Post": {
"description": "Class ContactBase",
"required": [
"name",
"items"
],
"properties": {
"name": {
"description": "Display name of the contact or group",
"type": "string"
},
"items": {
"description": "List of email addresses contained in the contact",
"type": "array",
"items": {
"$ref": "#/components/schemas/ContactItem.Post"
}
},
"addLinks": {
"description": "Indicates whether HATEOAS links should be included in the response",
"type": "boolean"
}
}
},
"ContactBase.Put": {
"description": "Class ContactBase",
"required": [
"name",
"items"
],
"properties": {
"name": {
"description": "Display name of the contact or group",
"type": "string"
},
"items": {
"description": "List of email addresses contained in the contact",
"type": "array",
"items": {
"$ref": "#/components/schemas/ContactItem.Post"
}
},
"addLinks": {
"description": "Indicates whether HATEOAS links should be included in the response",
"type": "boolean"
}
}
},
"LdapGroup": {
"description": "Class LdapGroup",
"required": [
"id",
"name"
],
"properties": {
"id": {
"description": "LDAP group unique identifier",
"type": "integer"
},
"name": {
"description": "Display name of the LDAP group",
"type": "string"
},
"email": {
"description": "LDAP group email address",
"type": "string"
},
"description": {
"description": "LDAP group description",
"type": "string"
},
"links": {
"description": "HATEOAS links associated with the entity",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"LdapGroup.Post": {
"description": "Class LdapGroup",
"required": [
"dn"
],
"properties": {
"dn": {
"description": "LDAP distinguished name (DN)",
"type": "string"
},
"email": {
"description": "LDAP group email address",
"type": "string"
},
"description": {
"description": "LDAP group description",
"type": "string"
},
"addLinks": {
"description": "Indicates whether HATEOAS links should be included in the response",
"type": "boolean"
}
}
},
"LdapGroup.Put": {
"description": "Class LdapGroup",
"properties": {
"email": {
"description": "LDAP group email address",
"type": "string"
},
"description": {
"description": "LDAP group description",
"type": "string"
},
"addLinks": {
"description": "Indicates whether HATEOAS links should be included in the response",
"type": "boolean"
}
}
},
"MoveEcItemJob": {
"properties": {
"id": {
"description": "Job unique identifier",
"type": "string"
},
"status": {
"description": "Current job status. Accepted values: `queued`, `working`, `succeeded`, `failed`",
"type": "string"
},
"errors": {
"description": "List of errors that occurred during job processing",
"type": "string"
},
"objectIds": {
"description": "List of object IDs associated with this job",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"SendMessage.Post": {
"description": "Class SendMessage",
"properties": {
"to": {
"description": "Unique identifiers of the TO recipient users",
"type": "array",
"items": {
"type": "string"
}
},
"cc": {
"description": "Unique identifiers of the CC recipient users",
"type": "array",
"items": {
"type": "string"
}
},
"bcc": {
"description": "Unique identifiers of the BCC recipient users",
"type": "array",
"items": {
"type": "string"
}
},
"subject": {
"description": "Subject of the email message",
"type": "string"
},
"body": {
"description": "Content of the email message",
"type": "string"
},
"secureBody": {
"description": "Indicates whether the message is secure.",
"type": "boolean"
}
}
},
"SendMessage.Put": {
"description": "Class SendMessage",
"properties": {
"to": {
"description": "Unique identifiers of the TO recipient users",
"type": "array",
"items": {
"type": "string"
}
},
"cc": {
"description": "Unique identifiers of the CC recipient users",
"type": "array",
"items": {
"type": "string"
}
},
"bcc": {
"description": "Unique identifiers of the BCC recipient users",
"type": "array",
"items": {
"type": "string"
}
},
"subject": {
"description": "Subject of the email message",
"type": "string"
},
"body": {
"description": "Content of the email message",
"type": "string"
},
"secureBody": {
"description": "Indicates whether the message is secure.",
"type": "boolean"
}
}
},
"Profile": {
"description": "Class Profile",
"required": [
"builtIn",
"cloneable",
"id",
"name",
"prototype"
],
"properties": {
"id": {
"description": "Unique Profile identifier",
"type": "integer"
},
"name": {
"description": "Display name of the profile",
"type": "string"
},
"prototype": {
"description": "Prototype Profile identifier",
"type": "integer"
},
"builtIn": {
"description": "Indicates whether the profile is a built-in profile",
"type": "integer"
},
"cloneable": {
"description": "Indicates whether the profile can be used as a prototype for new custom profiles",
"type": "integer"
},
"features": {
"description": "List of feature settings and their enabled state for the profile",
"type": "array",
"items": {
"$ref": "#/components/schemas/FeaturesList"
}
}
}
},
"Profile.Post": {
"description": "Class Profile",
"required": [
"name"
],
"properties": {
"name": {
"description": "Display name of the profile",
"type": "string"
},
"prototype": {
"description": "Id of the prototype profile to be cloned. If not passed, the Standard profile will be used",
"type": "integer"
}
}
},
"Profile.Put": {
"description": "Class Profile",
"required": [
"name"
],
"properties": {
"name": {
"description": "Display name of the profile",
"type": "string"
},
"prototype": {
"description": "Id of the prototype profile to be cloned. If not passed, the Standard profile will be used",
"type": "integer"
}
}
},
"ApprovalRequestLink": {
"description": "Class MailLink",
"properties": {
"expire": {
"description": "Date and time after which the shortlink becomes invalid and can no longer be used",
"type": "string",
"format": "date"
},
"entityTypeId": {
"description": "Unique identifier of the entity type this shortlink is associated with",
"type": "integer"
},
"entityId": {
"description": "Unique identifier of the entity this shortlink points to, returned as a GUID from version 19 onwards",
"type": "string"
},
"entityTypeName": {
"description": "Human-readable name of the entity type this shortlink is associated with",
"type": "string"
},
"links": {
"description": "HATEOAS links associated with the entity",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"ApprovalRequestLink.Post": {
"description": "Class MailLink",
"properties": {
"ref": {
"description": "Shortlink handle. Example: abcdefg12",
"type": "string"
},
"expire": {
"description": "Date and time after which the shortlink becomes invalid and can no longer be used",
"type": "string",
"format": "date"
},
"entityTypeId": {
"description": "Unique identifier of entity type.\n * 1 = object,\n * 2 = email_package,\n * 3 = verification_code,\n * 4 = email_preview_package,\n * 5 = file_request,\n * 6 = add_file\n * 7 = password_reset,\n * 8 = gdrive_oauth,\n * 9 = connector_oauth,\n * 10 = comment,\n * 11 = task,\n * 12 = mobile_sync,\n * 13 = password_set,\n * 14 = event,\n * 15 = mail,\n * 16 = approval_request",
"type": "integer"
},
"entityId": {
"description": "Unique identifier of the entity this shortlink points to",
"type": "integer"
},
"length": {
"description": "Number of characters in the generated shortlink handle",
"type": "integer"
},
"addLinks": {
"description": "Indicates whether HATEOAS links should be included in the response",
"type": "boolean"
}
}
},
"ApprovalRequestLink.Put": {
"description": "Class MailLink",
"properties": {
"ref": {
"description": "Shortlink handle. Example: abcdefg12",
"type": "string"
},
"expire": {
"description": "Date and time after which the shortlink becomes invalid and can no longer be used",
"type": "string",
"format": "date"
},
"entityTypeId": {
"description": "Unique identifier of entity type.\n * 1 = object,\n * 2 = email_package,\n * 3 = verification_code,\n * 4 = email_preview_package,\n * 5 = file_request,\n * 6 = add_file\n * 7 = password_reset,\n * 8 = gdrive_oauth,\n * 9 = connector_oauth,\n * 10 = comment,\n * 11 = task,\n * 12 = mobile_sync,\n * 13 = password_set,\n * 14 = event,\n * 15 = mail,\n * 16 = approval_request",
"type": "integer"
},
"entityId": {
"description": "Unique identifier of the entity this shortlink points to",
"type": "integer"
},
"length": {
"description": "Number of characters in the generated shortlink handle",
"type": "integer"
},
"addLinks": {
"description": "Indicates whether HATEOAS links should be included in the response",
"type": "boolean"
}
}
},
"UserMetadata": {
"description": "Class UserMetadata",
"properties": {
"name": {
"description": "Key name of the custom metadata attribute associated with the user",
"type": "string"
},
"value": {
"description": "Value assigned to the custom metadata attribute for the user",
"type": "string"
}
}
},
"RiskPolicyReportFile": {
"description": "Class RiskPolicyReportFile",
"required": [
"id",
"locked",
"name",
"parentId",
"size",
"type",
"userId",
"wopiapp"
],
"properties": {
"id": {
"description": "Unique identifier of object",
"type": "string"
},
"created": {
"description": "Date and time when the object was created",
"type": "string",
"format": "date-time"
},
"deleted": {
"description": "Indicates whether the object is deleted",
"type": "boolean"
},
"permDeleted": {
"description": "Indicates whether the object is permanently deleted",
"type": "boolean"
},
"expire": {
"description": "Date and time when the object expires and becomes inaccessible",
"type": "string",
"format": "date-time"
},
"modified": {
"description": "Date and time when the object was last modified",
"type": "string",
"format": "date-time"
},
"name": {
"description": "Display name of the object",
"type": "string"
},
"parentId": {
"description": "Parent Folder identifier",
"type": "string"
},
"userId": {
"description": "Unique identifier of Object creator",
"type": "string"
},
"parent": {
"description": "Folder that directly contains this object (Explicit field. May be retrieved only if mentioned in \"with\" parameter)",
"$ref": "#/components/schemas/Folder"
},
"permalink": {
"description": "Permanent URL for accessing the object in the web application",
"type": "string"
},
"creator": {
"description": "Basic profile information of the user who created the object (Explicit field. May be retrieved only if mentioned in \"with\" parameter)",
"$ref": "#/components/schemas/UserBasicInfo"
},
"permissions": {
"description": "Current user's permissions (Explicit field. May be retrieved only if mentioned in \"with\" parameter)",
"type": "array",
"items": {
"$ref": "#/components/schemas/Permission"
}
},
"vendorDocId": {
"description": "Identifier of the corresponding document in the external vendor system (Explicit field. May be retrieved only if mentioned in \"with\" parameter)",
"type": "string"
},
"vendorDocName": {
"description": "Display name of the corresponding document in the external vendor system (Explicit field. May be retrieved only if mentioned in \"with\" parameter)",
"type": "string"
},
"source": {
"description": "Numeric code identifying the external system that originated this object (e.g. Salesforce, Teams)",
"type": "integer"
},
"links": {
"description": "HATEOAS links associated with the entity",
"type": "array",
"items": {
"type": "string"
}
},
"mime": {
"description": "File MIME type",
"type": "string"
},
"size": {
"description": "Size of the file content in bytes",
"type": "string"
},
"fingerprint": {
"description": "Cryptographic fingerprint (hash) of the file content used for integrity verification",
"type": "string"
},
"tracking_id": {
"description": "File tracking ID (UUID)",
"type": "string"
},
"type": {
"type": "string"
},
"locked": {
"description": "Unique identifier of User who locked a File",
"type": "integer"
},
"lockUser": {
"description": "User who locked the File (Explicit field. May be retrieved only if mentioned in \"with\" parameter)",
"$ref": "#/components/schemas/User"
},
"clientCreated": {
"description": "Original created time of the file",
"type": "string",
"format": "date"
},
"clientModified": {
"description": "Original modified time of the file",
"type": "string",
"format": "date"
},
"members": {
"description": "File members list (Explicit field. May be retrieved only if mentioned in \"with\" parameter)",
"type": "array",
"items": {
"$ref": "#/components/schemas/Member"
}
},
"overriddenExpire": {
"description": "Indicates whether the file expiration date is overridden",
"type": "boolean"
},
"originalFileId": {
"description": "File identifier from which this file was copied from",
"type": "string"
},
"pushedObject": {
"description": "Contains pushedObject data if current file was ever pushed (Explicit field. May be retrieved only if mentioned in \"with\" parameter)",
"$ref": "#/components/schemas/PushedObject"
},
"avStatus": {
"description": "Check file availability status according to AV settings and file scanned/infected status",
"type": "string"
},
"dlpStatus": {
"description": "Check file availability status according to DLP settings and file scanned/infected status",
"type": "string"
},
"adminQuarantineStatus": {
"description": "Check file availability status according to admin quarantined status",
"type": "string"
},
"storageAvailable": {
"description": "Boolean value that shows if this file is available on any volume",
"type": "boolean"
},
"lastModifiedBy": {
"description": "Creator of the latest version (Explicit field. May be retrieved only if mentioned in \"with\" parameter)",
"$ref": "#/components/schemas/User"
},
"wopiapp": {
"description": "WOPI info for iOS app",
"type": "boolean"
},
"roleId": {
"description": "Highest role of the current user on this file",
"type": "string"
},
"isShared": {
"description": "Indicates whether the file is shared",
"type": "string"
},
"fingerprints": {
"description": "Array of file fingerprint objects",
"type": "array",
"items": {
"type": "string"
}
},
"tags": {
"description": "Array of tag objects",
"type": "array",
"items": {
"$ref": "#/components/schemas/Tag"
}
}
}
},
"RiskPolicyReportFile.Post": {
"description": "Class RiskPolicyReportFile",
"required": [
"name"
],
"properties": {
"addLinks": {
"description": "Indicates whether HATEOAS links should be included in the response",
"type": "boolean"
},
"name": {
"description": "Display name of the file",
"type": "string"
}
}
},
"RiskPolicyReportFile.Put": {
"description": "Class RiskPolicyReportFile",
"required": [
"name"
],
"properties": {
"addLinks": {
"description": "Indicates whether HATEOAS links should be included in the response",
"type": "boolean"
},
"name": {
"description": "Display name of the file",
"type": "string"
},
"expire": {
"description": "The file expiration date.",
"type": "string"
},
"replace": {
"description": "Replace the file if file with same name exists",
"type": "string"
}
}
},
"DistributionList": {
"description": "Class DistributionList",
"required": [
"isDistributionList"
],
"properties": {
"isDistributionList": {
"description": "Indicates whether the email belongs to a distribution list",
"type": "boolean"
},
"members": {
"description": "List of members in the distribution list",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"Folder": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"description": "Unique identifier (UUID) of the folder."
},
"parentId": {
"type": "string",
"format": "uuid",
"description": "Unique identifier (UUID) of the parent object."
},
"name": {
"type": "string",
"description": "Name of the object."
},
"type": {
"type": "string",
"description": "Type of the object.
`f` \u2013 File.
`d` \u2013 Folder."
},
"userId": {
"type": "string",
"format": "uuid",
"description": "Unique identifier (UUID) who created the folder."
},
"creator": {
"description": "Details of the user who created the object.",
"allOf": [
{
"$ref": "#/components/schemas/UserBasic"
}
]
},
"created": {
"type": "string",
"format": "date",
"description": "The date and time when the object was created."
},
"modified": {
"type": "string",
"format": "date",
"description": "The date and time when the object was last modified."
},
"expire": {
"type": "string",
"format": "date",
"description": "Expiration timestamp of the object, if applicable."
},
"permissions": {
"description": "List of permissions associated with the object.",
"type": "array",
"items": {
"$ref": "#/components/schemas/Permission"
}
},
"deleted": {
"type": "boolean",
"description": "Indicates whether the object has been deleted."
},
"permDeleted": {
"type": "boolean",
"description": "Indicates whether the object has been permanently deleted."
},
"permalink": {
"type": "string",
"description": "Permanent URL link to access the object."
},
"path": {
"type": "string",
"description": "Path to the folder in the hierarchy."
},
"members": {
"description": "List of members who have access to the object.",
"type": "array",
"items": {
"$ref": "#/components/schemas/Member"
}
},
"vendorDocId": {
"type": "string",
"description": "Vendor document ID associated with the object."
},
"vendorDocName": {
"type": "string",
"description": "Name of the vendor document associated with the object."
},
"secure": {
"type": "boolean",
"description": "Indicates whether the folder or the parent folder containing the file is marked as secure."
},
"source": {
"type": "integer",
"description": "ID representing the source of the object (1 - Salesforce, 2 - Teams)."
},
"isShared": {
"type": "boolean",
"description": "Indicates if the folder is shared with other users."
},
"syncable": {
"type": "boolean",
"description": "Indicates if the folder can be synced by Desktop Sync Client."
},
"fileLifetime": {
"type": "integer",
"description": "Time duration (in days) for which the files in this folder are kept after being added to the folder."
},
"description": {
"type": "string",
"description": "The description of the folder."
},
"isFavorite": {
"type": "boolean",
"description": "Indicates if the folder is marked as a favorite by the user."
},
"pushedFilesCount": {
"type": "integer",
"description": "The number of files that have been pushed to mobile apps in this folder."
},
"currentUserRole": {
"description": "The role of the current user in this folder.",
"allOf": [
{
"$ref": "#/components/schemas/Role"
}
]
},
"avStatus": {
"type": "string",
"description": "The Antivirus (AV) status of the folder."
},
"dlpStatus": {
"type": "string",
"description": "The Data Loss Prevention (DLP) status of the folder."
},
"totalMembersCount": {
"type": "integer",
"description": "Total number of members who have access to this folder."
},
"totalFoldersCount": {
"type": "integer",
"description": "Total number of subfolders within this folder."
},
"totalFilesCount": {
"type": "integer",
"description": "Total number of files within this folder."
},
"maxFolderExpiration": {
"type": "string",
"format": "date",
"description": "The maximum expiration date allowed for files in this folder."
},
"maxFileLifetime": {
"type": "integer",
"description": "The maximum duration (in days) that files in this folder can be kept after being added to the folder."
},
"isLdapGroupMember": {
"type": "boolean",
"description": "Indicates if the folder is part of an LDAP group."
},
"isUnderMyFolder": {
"type": "boolean",
"description": "Indicates if this folder is a subfolder of the user's \"My Folder\"."
},
"pathIds": {
"type": "string",
"description": "A list of IDs representing the path of the folder within the folder hierarchy."
},
"isRoot": {
"type": "boolean",
"description": "Indicates if this folder is a root folder."
},
"rootId": {
"type": "string",
"format": "uuid",
"description": "The ID of the root folder if this is a subfolder."
},
"useFolderQuota": {
"type": "boolean",
"description": "Indicates if a folder quota is applied to this folder."
},
"quota": {
"type": "integer",
"description": "The storage quota for the folder (in bytes)."
},
"size": {
"type": "integer",
"description": "The total storage size used by the folder (in bytes)."
},
"freeSpace": {
"type": "integer",
"description": "The amount of free space available in the folder (in bytes)."
},
"inheritanceEnabled": {
"type": "boolean",
"description": "Indicates if a folder inherits permissions from the parent folder"
}
}
},
"Folder.Post": {
"description": "Class Folder",
"required": [
"name"
],
"properties": {
"addLinks": {
"description": "Indicates whether HATEOAS links should be included in the response",
"type": "boolean"
},
"name": {
"description": "Display name of the folder",
"type": "string"
},
"description": {
"description": "Optional text description of the folder's purpose or contents",
"type": "string"
},
"syncable": {
"description": "Indicates that folder is syncable. Can only be set at a top level folder.",
"type": "boolean"
},
"expire": {
"description": "The folder expiration date. Applicable to top level folders",
"type": "string",
"format": "date"
},
"fileLifetime": {
"description": "The file's lifetime in the folder",
"type": "integer"
},
"inheritanceEnabled": {
"description": "Set to false to disable permission inheritance for this subfolder",
"type": "boolean"
},
"secure": {
"description": "Indicates whether folder is secure. Only top level folders under user's root folder can be set to secure",
"type": "boolean"
}
}
},
"Folder.Put": {
"description": "Class Folder",
"required": [
"name"
],
"properties": {
"addLinks": {
"description": "Indicates whether HATEOAS links should be included in the response",
"type": "boolean"
},
"name": {
"description": "Display name of the folder",
"type": "string"
},
"description": {
"description": "Optional text description of the folder's purpose or contents",
"type": "string"
},
"syncable": {
"description": "Indicates that folder is syncable. Can only be set at a top level folder.",
"type": "boolean"
},
"expire": {
"description": "The folder expiration date. Applicable to top level folders",
"type": "string",
"format": "date"
},
"fileLifetime": {
"description": "The file's lifetime in the folder",
"type": "integer"
},
"inheritanceEnabled": {
"description": "Set to false to disable permission inheritance for this subfolder",
"type": "boolean"
},
"applyFileLifetimeToFiles": {
"description": "Apply file lifetime setting to existing files",
"type": "boolean"
},
"applyFileLifetimeToNested": {
"description": "Apply file lifetime setting to nested folders",
"type": "boolean"
},
"secure": {
"description": "Indicates whether folder is secure. Only top level folders under user's root folder can be set to secure",
"type": "boolean"
}
}
},
"Timezone": {
"description": "Class Timezone",
"required": [
"name"
],
"properties": {
"id": {
"description": "Timezone unique identifier",
"type": "integer"
},
"name": {
"description": "Display name of the timezone (e.g. America/New_York)",
"type": "string"
},
"offset": {
"description": "Timezone offset in seconds",
"type": "integer"
},
"supportsDST": {
"description": "Indicates whether the timezone supports daylight saving time (DST)",
"type": "boolean"
},
"links": {
"description": "HATEOAS links associated with the entity",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"Timezone.Post": {
"description": "Class Timezone",
"properties": {
"addLinks": {
"description": "Indicates whether HATEOAS links should be included in the response",
"type": "boolean"
}
}
},
"Timezone.Put": {
"description": "Class Timezone",
"properties": {
"addLinks": {
"description": "Indicates whether HATEOAS links should be included in the response",
"type": "boolean"
}
}
},
"MediaType": {
"description": "Class MediaType",
"properties": {
"id": {
"description": "Media type unique identifier",
"type": "integer"
},
"mediaType": {
"description": "MIME type string identifying the media format, e.g. `image/png`",
"type": "string"
},
"links": {
"description": "HATEOAS links associated with the entity",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"MediaType.Post": {
"description": "Class MediaType",
"properties": {
"addLinks": {
"description": "Indicates whether HATEOAS links should be included in the response",
"type": "boolean"
}
}
},
"MediaType.Put": {
"description": "Class MediaType",
"properties": {
"addLinks": {
"description": "Indicates whether HATEOAS links should be included in the response",
"type": "boolean"
}
}
},
"EmailPreviewLink": {
"description": "Class EmailPreviewLink",
"properties": {
"expire": {
"description": "Date and time after which the shortlink becomes invalid and can no longer be used",
"type": "string",
"format": "date"
},
"entityTypeId": {
"description": "Unique identifier of the entity type this shortlink is associated with",
"type": "integer"
},
"entityId": {
"description": "Unique identifier of the entity this shortlink points to, returned as a GUID from version 19 onwards",
"type": "string"
},
"entityTypeName": {
"description": "Human-readable name of the entity type this shortlink is associated with",
"type": "string"
},
"links": {
"description": "HATEOAS links associated with the entity",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"EmailPreviewLink.Post": {
"description": "Class EmailPreviewLink",
"properties": {
"ref": {
"description": "Shortlink handle. Example: abcdefg12",
"type": "string"
},
"expire": {
"description": "Date and time after which the shortlink becomes invalid and can no longer be used",
"type": "string",
"format": "date"
},
"entityTypeId": {
"description": "Unique identifier of entity type.\n * 1 = object,\n * 2 = email_package,\n * 3 = verification_code,\n * 4 = email_preview_package,\n * 5 = file_request,\n * 6 = add_file\n * 7 = password_reset,\n * 8 = gdrive_oauth,\n * 9 = connector_oauth,\n * 10 = comment,\n * 11 = task,\n * 12 = mobile_sync,\n * 13 = password_set,\n * 14 = event,\n * 15 = mail,\n * 16 = approval_request",
"type": "integer"
},
"entityId": {
"description": "Unique identifier of the entity this shortlink points to",
"type": "integer"
},
"length": {
"description": "Number of characters in the generated shortlink handle",
"type": "integer"
},
"addLinks": {
"description": "Indicates whether HATEOAS links should be included in the response",
"type": "boolean"
}
}
},
"EmailPreviewLink.Put": {
"description": "Class EmailPreviewLink",
"properties": {
"ref": {
"description": "Shortlink handle. Example: abcdefg12",
"type": "string"
},
"expire": {
"description": "Date and time after which the shortlink becomes invalid and can no longer be used",
"type": "string",
"format": "date"
},
"entityTypeId": {
"description": "Unique identifier of entity type.\n * 1 = object,\n * 2 = email_package,\n * 3 = verification_code,\n * 4 = email_preview_package,\n * 5 = file_request,\n * 6 = add_file\n * 7 = password_reset,\n * 8 = gdrive_oauth,\n * 9 = connector_oauth,\n * 10 = comment,\n * 11 = task,\n * 12 = mobile_sync,\n * 13 = password_set,\n * 14 = event,\n * 15 = mail,\n * 16 = approval_request",
"type": "integer"
},
"entityId": {
"description": "Unique identifier of the entity this shortlink points to",
"type": "integer"
},
"length": {
"description": "Number of characters in the generated shortlink handle",
"type": "integer"
},
"addLinks": {
"description": "Indicates whether HATEOAS links should be included in the response",
"type": "boolean"
}
}
},
"Bandwidth": {
"description": "Class Bandwidth",
"properties": {
"dateTime": {
"description": "Bandwidth measurement date and time",
"type": "string",
"format": "date"
},
"eventStatus": {
"description": "Event status. Accepted values: `1` (upload), `2` (download)",
"type": "integer"
},
"usage": {
"description": "Bandwidth usage in bytes",
"type": "integer"
}
}
},
"EcmAuth": {
"description": "Class EcmAuth",
"properties": {
"redirect": {
"description": "OAuth redirect URL for the cloud source",
"type": "string"
},
"clientId": {
"description": "Cloud source OAuth client unique identifier",
"type": "string"
}
}
},
"Language": {
"description": "Class Language",
"properties": {
"id": {
"description": "Language unique identifier",
"type": "integer"
},
"name": {
"description": "Display name of the language",
"type": "string"
},
"symbol": {
"description": "Short symbol code identifying the language",
"type": "string"
},
"ietf": {
"description": "IETF BCP 47 language tag used for locale identification, e.g. `en-US`",
"type": "string"
},
"links": {
"description": "HATEOAS links associated with the entity",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"Language.Post": {
"description": "Class Language",
"properties": {
"addLinks": {
"description": "Indicates whether HATEOAS links should be included in the response",
"type": "boolean"
}
}
},
"Language.Put": {
"description": "Class Language",
"properties": {
"addLinks": {
"description": "Indicates whether HATEOAS links should be included in the response",
"type": "boolean"
}
}
},
"Preview": {
"description": "Class Preview",
"properties": {
"link": {
"description": "Preview link for the file",
"type": "string"
},
"pdf": {
"description": "PDF file for the preview",
"type": "string"
},
"viewUrl": {
"description": "URL for viewing the preview",
"type": "string"
},
"status": {
"description": "Preview processing status. Accepted values: `processing`, `preview`, `failed`",
"type": "string"
},
"type": {
"description": "Format of the generated preview, such as image or PDF",
"type": "string"
},
"metadata": {
"description": "Additional metadata about the preview, such as dimensions or page count",
"type": "string"
},
"mime": {
"description": "MIME type of the preview file",
"type": "string"
},
"native": {
"description": "Indicates whether the preview is a native render",
"type": "boolean"
},
"watermark": {
"description": "Watermark applied to the preview",
"type": "string"
},
"tdfOriginalExtension": {
"description": "Original file extension for TDF files",
"type": "string"
}
}
},
"MobileSync": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "Unique identifier of MobileSync"
},
"fileId": {
"type": "string",
"description": "Unique identifier (UUID) of the synced file."
},
"userId": {
"type": "string"
},
"pushUserId": {
"type": "string"
},
"created": {
"type": "string",
"format": "date",
"description": "Mobile sync item creation date"
},
"fingerprint": {
"type": "string",
"description": "MD5 file fingerprint"
},
"fingerprints": {
"type": "array",
"description": "List of all file fingerprints",
"items": {
"$ref": "#/components/schemas/Fingerprint"
}
},
"secure": {
"type": "boolean",
"description": "Indicates that File is in secure Folder"
},
"toBeNotified": {
"type": "boolean",
"description": "Indicates that Email notification for this item was sent"
},
"pushedObject": {
"description": "Details of the push operation for this sync item, if applicable.",
"allOf": [
{
"$ref": "#/components/schemas/PushedObject"
}
]
},
"syncedObject": {
"description": "Details of the sync operation for this item, if applicable.",
"allOf": [
{
"$ref": "#/components/schemas/SyncedObject"
}
]
},
"pushUser": {
"description": "Details of the user who added this file to the sync list.",
"allOf": [
{
"$ref": "#/components/schemas/UserBasic"
}
]
},
"avStatus": {
"type": "string",
"description": "Antivirus (AV) scan status of the synced file."
},
"dlpStatus": {
"type": "string",
"description": "Data Loss Prevention (DLP) scan status of the synced file."
},
"file": {
"description": "Details of the synced file.",
"allOf": [
{
"$ref": "#/components/schemas/File"
}
]
}
}
},
"MobileSync.Post": {
"description": "Class MobileSync",
"required": [
"fileId"
],
"properties": {
"fileId": {
"description": "Unique identifier of File",
"type": "integer"
},
"addLinks": {
"description": "Indicates whether HATEOAS links should be included in the response",
"type": "boolean"
}
}
},
"MobileSync.Put": {
"description": "Class MobileSync",
"required": [
"fileId"
],
"properties": {
"fileId": {
"description": "Unique identifier of File",
"type": "integer"
},
"addLinks": {
"description": "Indicates whether HATEOAS links should be included in the response",
"type": "boolean"
}
}
},
"FileType": {
"description": "Class FileType",
"required": [
"extension",
"groupName",
"id",
"mediaTypes"
],
"properties": {
"id": {
"description": "Unique identifier of File Type",
"type": "integer"
},
"mediaTypes": {
"description": "List of associated media types",
"type": "array",
"items": {
"$ref": "#/components/schemas/MediaTypeItem"
}
},
"extension": {
"description": "File extension associated with this file type (e.g. pdf, docx)",
"type": "string"
},
"groupName": {
"description": "Display name of the group this file type belongs to",
"type": "string"
},
"links": {
"description": "HATEOAS links associated with the entity",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"FileType.Post": {
"description": "Class FileType",
"properties": {
"addLinks": {
"description": "Indicates whether HATEOAS links should be included in the response",
"type": "boolean"
}
}
},
"FileType.Put": {
"description": "Class FileType",
"properties": {
"addLinks": {
"description": "Indicates whether HATEOAS links should be included in the response",
"type": "boolean"
}
}
},
"UserBasicInfo": {
"required": [
"email",
"id",
"name"
],
"properties": {
"id": {
"description": "The unique identifier of the user",
"type": "string"
},
"name": {
"description": "The name of the user",
"type": "string"
},
"email": {
"description": "The user's email",
"type": "string"
},
"profileIcon": {
"description": "URL to the user's profile icon image",
"type": "string"
}
}
},
"UserBasicInfo.Post": {
"required": [
"email"
],
"properties": {
"name": {
"description": "The name of the user",
"type": "string"
},
"email": {
"description": "The user's email",
"type": "string"
}
}
},
"UserBasicInfo.Put": {
"properties": {
"name": {
"description": "The name of the user",
"type": "string"
}
}
},
"PasswordPolicy": {
"description": "Class PasswordPolicy",
"required": [
"allowAutoFill",
"enabled",
"minCharacters",
"minDigits",
"minLowerCharacters",
"minSpecialCharacters",
"minUpperCharacters"
],
"properties": {
"allowAutoFill": {
"description": "Indicates whether browsers are allowed to fill in the password automatically",
"type": "boolean"
},
"enabled": {
"description": "Indicates whether the password policy is enabled",
"type": "boolean"
},
"minCharacters": {
"description": "Minimum length of the password",
"type": "integer"
},
"minDigits": {
"description": "Minimum number of numeric characters required in the password",
"type": "integer"
},
"minLowerCharacters": {
"description": "Minimum number of lowercase characters required in the password",
"type": "integer"
},
"minSpecialCharacters": {
"description": "Minimum number of special characters required in the password",
"type": "integer"
},
"minUpperCharacters": {
"description": "Minimum number of uppercase characters required in the password",
"type": "integer"
}
}
},
"Settings": {
"description": "Class Settings",
"properties": {
"languageId": {
"description": "Language identifier of the user the settings represent",
"type": "integer"
},
"locationId": {
"description": "Location identifier for user settings. User's personal default location for file send and uploads",
"type": "integer"
},
"signature": {
"description": "Email message signature",
"type": "string"
},
"storageUsed": {
"description": "Storage used by the user across the folders they own",
"type": "integer"
},
"storageQuota": {
"description": "Storage quota allocated to the user across all the folders they own",
"type": "integer"
},
"mobileKeyStore": {
"description": "Encrypted key store data used by the mobile client for secure operations",
"type": "string"
},
"mobileNumber": {
"description": "User's mobile number",
"type": "string"
},
"mobileNumberVerified": {
"description": "Indicates whether the mobile number is verified",
"type": "boolean"
},
"links": {
"description": "HATEOAS links associated with the entity",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"Location": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "Location ID"
},
"name": {
"type": "string",
"description": "Location name"
},
"dns": {
"type": "string",
"description": "Location DNS"
},
"tenantId": {
"type": "integer",
"description": "Tenant ID"
}
}
},
"Location.Post": {
"description": "Class Location",
"required": [
"name",
"domain"
],
"properties": {
"name": {
"description": "Location name. Ask administrator for location names for your server",
"type": "string"
},
"domain": {
"description": "A URL domain that can be used to access the servers in this location,\n e.g. location.domain.com.\n The domain should be registered in a DNS to point to the servers.",
"type": "string"
},
"addLinks": {
"description": "Indicates whether HATEOAS links should be included in the response",
"type": "boolean"
}
}
},
"Location.Put": {
"description": "Class Location",
"required": [
"name",
"domain"
],
"properties": {
"name": {
"description": "Location name. Ask administrator for location names for your server",
"type": "string"
},
"domain": {
"description": "A URL domain that can be used to access the servers in this location,\n e.g. location.domain.com.\n The domain should be registered in a DNS to point to the servers.",
"type": "string"
},
"addLinks": {
"description": "Indicates whether HATEOAS links should be included in the response",
"type": "boolean"
}
}
},
"SourceType": {
"description": "Class SourceType",
"properties": {
"id": {
"description": "Unique identifier of Source type",
"type": "integer"
},
"name": {
"description": "Display name of the source type",
"type": "string"
},
"userCanSet": {
"description": "Indicates whether the user can set this source type",
"type": "boolean"
},
"links": {
"description": "HATEOAS links associated with the entity",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"SourceType.Post": {
"description": "Class SourceType",
"properties": {
"addLinks": {
"description": "Indicates whether HATEOAS links should be included in the response",
"type": "boolean"
}
}
},
"SourceType.Put": {
"description": "Class SourceType",
"properties": {
"addLinks": {
"description": "Indicates whether HATEOAS links should be included in the response",
"type": "boolean"
}
}
},
"Email": {
"description": "Class Email",
"required": [
"date",
"emailPackageId",
"id",
"modifiedDate",
"parentEmailId",
"recipients",
"senderId",
"status",
"subject",
"type"
],
"properties": {
"id": {
"description": "Email unique identifier",
"type": "string"
},
"senderId": {
"description": "Unique identifier of User who sent Email",
"type": "string"
},
"templateId": {
"description": "Email template unique identifier",
"type": "integer"
},
"status": {
"description": "Email status. Accepted values: `sent`, `draft`, `queued`, `transferring`, `error`, `self_send`",
"type": "string"
},
"type": {
"description": "Email type. Accepted values: `original`, `resend`, `forward`, `reply`",
"type": "string"
},
"date": {
"description": "Date and time the email was created",
"type": "string",
"format": "date"
},
"deleted": {
"description": "Indicates whether the email is deleted",
"type": "boolean"
},
"emailPackageId": {
"description": "Email Package unique identifier",
"type": "string"
},
"isPreview": {
"description": "Indicates whether the email is a preview email",
"type": "boolean"
},
"isUserSent": {
"description": "Indicates whether the email was sent by a user",
"type": "boolean"
},
"watermark": {
"description": "The watermark on the preview email",
"type": "string"
},
"package": {
"description": "(Explicit field. May be retrieved only if mentioned in \"with\" parameter)",
"$ref": "#/components/schemas/Package"
},
"expirationDate": {
"description": "Email package expiration date",
"type": "string",
"format": "date-time"
},
"attachmentCount": {
"description": "Number of attachments in the email package",
"type": "integer"
},
"sender": {
"description": "Sender's basic information (Explicit field. May be retrieved only if mentioned in \"with\" parameter)",
"$ref": "#/components/schemas/UserBasicInfo"
},
"recipients": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Recipient"
}
},
"variables": {
"type": "array",
"items": {
"type": "string"
}
},
"secureBody": {
"description": "Indicates whether the email body is secured",
"type": "boolean"
},
"modifiedDate": {
"description": "Date and time the email was last modified",
"type": "string",
"format": "date"
},
"parentEmailId": {
"description": "Unique identifier of the original email this email was forwarded or replied from",
"type": "string"
},
"emailReturnReceipt": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EmailReturnReceipt"
}
},
"error": {
"description": "Error message when the email status is error",
"type": "string"
},
"subject": {
"description": "Subject line of the email as shown to recipients",
"type": "string"
},
"body": {
"description": "(Explicit field. May be retrieved only if mentioned in \"with\" parameter)",
"type": "string"
},
"rawBody": {
"description": "(Explicit field. May be retrieved only if mentioned in \"with\" parameter)",
"type": "string"
},
"headline": {
"description": "(Explicit field. May be retrieved only if mentioned in \"with\" parameter)",
"type": "string"
},
"notice": {
"description": "(Explicit field. May be retrieved only if mentioned in \"with\" parameter)",
"type": "string"
},
"htmlBody": {
"description": "(Explicit field. May be retrieved only if mentioned in \"with\" parameter)",
"type": "string"
},
"fullHtmlBody": {
"description": "(Explicit field. May be retrieved only if mentioned in \"with\" parameter)",
"type": "string"
},
"emailFrom": {
"description": "(Explicit field. May be retrieved only if mentioned in \"with\" parameter)",
"type": "string"
},
"isRead": {
"description": "Indicates whether the email has been read by the current user",
"type": "boolean"
},
"bucket": {
"description": "Mailbox bucket the email belongs to. Accepted values: `inbox`, `sent`, `draft`, `outgoing`, `trash`",
"type": "string"
},
"templateBody": {
"description": "(Explicit field. May be retrieved only if mentioned in \"with\" parameter)",
"type": "string"
},
"webFormId": {
"description": "(Explicit field. May be retrieved only if mentioned in \"with\" parameter)",
"type": "string"
},
"webFormFields": {
"description": "(Explicit field. May be retrieved only if mentioned in \"with\" parameter)",
"type": "array",
"items": {
"type": "string"
}
},
"links": {
"description": "HATEOAS links associated with the entity",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"Email.Post": {
"description": "Class Email",
"required": [
"templateId",
"status"
],
"properties": {
"senderId": {
"description": "Unique identifier of User who sent Email",
"type": "integer"
},
"templateId": {
"description": "Email template unique identifier",
"type": "integer"
},
"status": {
"description": "Current delivery status of the email. Accepted values: `queued`, `draft`, `sent`, `error`",
"type": "string",
"enum": [
"queued",
"draft",
"sent",
"error"
]
},
"emailPackageId": {
"description": "Email Package unique identifier",
"type": "integer"
},
"secureBody": {
"type": "boolean"
},
"modifiedDate": {
"type": "string",
"format": "date"
},
"parentEmailId": {
"description": "The identifier of forwarded email",
"type": "integer"
},
"addLinks": {
"description": "Indicates whether HATEOAS links should be included in the response",
"type": "boolean"
}
}
},
"Email.Put": {
"description": "Class Email",
"required": [
"status"
],
"properties": {
"status": {
"description": "Current delivery status of the email. Accepted values: `queued`, `draft`, `sent`, `error`",
"type": "string",
"enum": [
"queued",
"draft",
"sent",
"error"
]
},
"emailPackageId": {
"description": "Email Package unique identifier",
"type": "integer"
},
"secureBody": {
"type": "boolean"
},
"modifiedDate": {
"type": "string",
"format": "date"
},
"parentEmailId": {
"description": "The identifier of forwarded email",
"type": "integer"
},
"addLinks": {
"description": "Indicates whether HATEOAS links should be included in the response",
"type": "boolean"
}
}
},
"BaseFile": {
"required": [
"id",
"name",
"parentId",
"size",
"userId"
],
"properties": {
"id": {
"description": "Unique identifier of object",
"type": "string"
},
"created": {
"description": "Date and time when the object was created",
"type": "string",
"format": "date-time"
},
"deleted": {
"description": "Indicates whether the object is deleted",
"type": "boolean"
},
"permDeleted": {
"description": "Indicates whether the object is permanently deleted",
"type": "boolean"
},
"expire": {
"description": "Date and time when the object expires and becomes inaccessible",
"type": "string",
"format": "date-time"
},
"modified": {
"description": "Date and time when the object was last modified",
"type": "string",
"format": "date-time"
},
"name": {
"description": "Display name of the object",
"type": "string"
},
"parentId": {
"description": "Parent Folder identifier",
"type": "string"
},
"userId": {
"description": "Unique identifier of Object creator",
"type": "string"
},
"parent": {
"description": "Folder that directly contains this object (Explicit field. May be retrieved only if mentioned in \"with\" parameter)",
"$ref": "#/components/schemas/Folder"
},
"permalink": {
"description": "Permanent URL for accessing the object in the web application",
"type": "string"
},
"creator": {
"description": "Basic profile information of the user who created the object (Explicit field. May be retrieved only if mentioned in \"with\" parameter)",
"$ref": "#/components/schemas/UserBasicInfo"
},
"permissions": {
"description": "Current user's permissions (Explicit field. May be retrieved only if mentioned in \"with\" parameter)",
"type": "array",
"items": {
"$ref": "#/components/schemas/Permission"
}
},
"vendorDocId": {
"description": "Identifier of the corresponding document in the external vendor system (Explicit field. May be retrieved only if mentioned in \"with\" parameter)",
"type": "string"
},
"vendorDocName": {
"description": "Display name of the corresponding document in the external vendor system (Explicit field. May be retrieved only if mentioned in \"with\" parameter)",
"type": "string"
},
"source": {
"description": "Numeric code identifying the external system that originated this object (e.g. Salesforce, Teams)",
"type": "integer"
},
"links": {
"description": "HATEOAS links associated with the entity",
"type": "array",
"items": {
"type": "string"
}
},
"mime": {
"description": "File MIME type",
"type": "string"
},
"size": {
"description": "Size of the file content in bytes",
"type": "string"
},
"fingerprint": {
"description": "Cryptographic fingerprint (hash) of the file content used for integrity verification",
"type": "string"
},
"tracking_id": {
"description": "File tracking ID (UUID)",
"type": "string"
}
}
},
"BaseFile.Post": {
"properties": {
"addLinks": {
"description": "Indicates whether HATEOAS links should be included in the response",
"type": "boolean"
}
}
},
"BaseFile.Put": {
"properties": {
"addLinks": {
"description": "Indicates whether HATEOAS links should be included in the response",
"type": "boolean"
}
}
},
"Tag": {
"type": "object",
"properties": {
"guid": {
"type": "string",
"format": "uuid",
"description": "Unique identifier (UUID) for the tag."
},
"name": {
"type": "string",
"description": "Display name of the tag."
},
"type": {
"type": "string",
"description": "Type category of the tag."
}
}
},
"Tag.Post": {
"description": "Class Tag",
"properties": {
"addLinks": {
"description": "Indicates whether HATEOAS links should be included in the response",
"type": "boolean"
}
}
},
"Tag.Put": {
"description": "Class Tag",
"properties": {
"addLinks": {
"description": "Indicates whether HATEOAS links should be included in the response",
"type": "boolean"
}
}
},
"Settings.Post": {
"description": "Class Settings",
"properties": {
"languageId": {
"description": "Language identifier for user settings",
"type": "integer"
},
"locationId": {
"description": "Location identifier for user settings. User's personal default location for file send and uploads",
"type": "integer"
},
"signature": {
"description": "Email message signature",
"type": "string"
},
"mobileKeyStore": {
"description": "Encrypted key store data used by the mobile client for secure operations",
"type": "string"
},
"addLinks": {
"description": "Indicates whether HATEOAS links should be included in the response",
"type": "boolean"
}
}
},
"Settings.Put": {
"description": "Class Settings",
"properties": {
"languageId": {
"description": "Language identifier for user settings",
"type": "integer"
},
"locationId": {
"description": "Location identifier for user settings. User's personal default location for file send and uploads",
"type": "integer"
},
"signature": {
"description": "Email message signature",
"type": "string"
},
"mobileKeyStore": {
"description": "Encrypted key store data used by the mobile client for secure operations",
"type": "string"
},
"addLinks": {
"description": "Indicates whether HATEOAS links should be included in the response",
"type": "boolean"
}
}
},
"MonthlyStorage": {
"description": "Class MonthlyStorage",
"properties": {
"dateTime": {
"description": "Storage measurement date",
"type": "string",
"format": "date"
},
"usage": {
"description": "Storage usage in bytes",
"type": "integer"
}
}
},
"Source": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique identifier of the external content source."
},
"name": {
"type": "string",
"description": "Display name of the external content source."
},
"description": {
"type": "string",
"description": "Description of the external content source."
},
"sourceUrl": {
"type": "string",
"description": "URL of the external content source."
},
"sourceTypeId": {
"type": "integer",
"description": "Numeric identifier of the source type."
},
"sourceByUser": {
"type": "boolean",
"description": "Indicates whether this source was added by the user."
},
"pinned": {
"type": "boolean",
"description": "Indicates whether the source is pinned."
},
"pinnedTime": {
"type": "string",
"format": "date",
"description": "Date and time when the source was pinned."
}
}
},
"Source.Post": {
"description": "Class Source",
"required": [
"name",
"sourceUrl",
"sourceTypeId"
],
"properties": {
"name": {
"description": "Display name of the source",
"type": "string"
},
"description": {
"description": "Optional description of the source providing additional context about its contents or purpose",
"type": "string"
},
"sourceUrl": {
"description": "URL of the external source system to connect to",
"type": "string"
},
"sourceTypeId": {
"description": "Unique identifier of source type",
"type": "string"
},
"username": {
"description": "Username for authenticating with the external source system",
"type": "string"
},
"password": {
"description": "Password for authenticating with the external source system",
"type": "string"
},
"repository": {
"description": "Name of the repository within the external source system to connect to",
"type": "string"
},
"addLinks": {
"description": "Indicates whether HATEOAS links should be included in the response",
"type": "boolean"
}
}
},
"Source.Put": {
"description": "Class Source",
"required": [
"name"
],
"properties": {
"name": {
"description": "Display name of the source",
"type": "string"
},
"description": {
"description": "Optional description of the source providing additional context about its contents or purpose",
"type": "string"
},
"addLinks": {
"description": "Indicates whether HATEOAS links should be included in the response",
"type": "boolean"
}
}
},
"WopiAccessToken": {
"properties": {
"accessToken": {
"description": "Access token used to authenticate WOPI requests for editing files",
"type": "string"
},
"expires": {
"description": "Date and time when the access token expires",
"type": "string",
"format": "date-time"
}
}
},
"RequestFile": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "Unique identifier for the request file."
},
"type": {
"type": "string",
"description": "The type of the request file."
},
"requestor": {
"description": "Information about the requestor (user who initiated the request).",
"allOf": [
{
"$ref": "#/components/schemas/UserBasic1"
}
]
},
"recipient": {
"description": "Information about the recipient (user to whom the file is sent).",
"allOf": [
{
"$ref": "#/components/schemas/UserBasic1"
}
]
},
"remaining": {
"type": "integer",
"description": "The number of remaining files or actions."
},
"fileLimit": {
"type": "integer",
"description": "The maximum number of files allowed for this request."
},
"email": {
"description": "Details of the email associated with the request file.",
"allOf": [
{
"$ref": "#/components/schemas/Mail2"
}
]
},
"message": {
"type": "string",
"description": "Message or note associated with the request file."
},
"requireAuth": {
"type": "boolean",
"description": "Indicates whether authentication is required to access the request file."
},
"expire": {
"type": "string",
"format": "date",
"description": "The expiration date of the request file."
},
"config": {
"description": "Configuration details for the request file.",
"allOf": [
{
"$ref": "#/components/schemas/RequestFileConfig"
}
]
},
"uploadLink": {
"type": "string",
"description": "Link for uploading the request file."
},
"ref": {
"type": "string",
"description": "Reference or identifier for the request file."
}
}
},
"RequestFile.Post": {
"description": "Class RequestFile",
"required": [
"to"
],
"properties": {
"to": {
"description": "Email recipients.",
"type": "array",
"items": {
"type": "string"
}
},
"subject": {
"description": "The subject of the email.",
"type": "string"
},
"body": {
"description": "The body of the email.",
"type": "string"
},
"expire": {
"description": "The expiration date for the requestFile link. After this date, the link becomes unusable, though the files' expiry will follow the folder's settings.",
"type": "string",
"format": "date-time"
},
"count": {
"description": "The remaining number of uploads allowed. -1 represents unlimited uploads.",
"type": "integer"
},
"requireAuth": {
"description": "Indicates whether the uploader is required to sign in to upload files.",
"type": "boolean"
},
"actionId": {
"description": "Specifies the allowed actions for the uploader: 1 for viewing, 2 for downloading.",
"type": "integer",
"enum": [
"1",
"2"
]
},
"files": {
"description": "An array of file IDs that the requester may want to include, and available for uploaders to see or download.",
"type": "array",
"items": {
"type": "string"
}
},
"secureBody": {
"type": "boolean"
},
"addLinks": {
"description": "Indicates whether HATEOAS links should be included in the response",
"type": "boolean"
}
}
},
"RequestFile.Put": {
"description": "Class RequestFile",
"required": [
"to"
],
"properties": {
"to": {
"description": "Email recipients.",
"type": "array",
"items": {
"type": "string"
}
},
"subject": {
"description": "The subject of the email.",
"type": "string"
},
"body": {
"description": "The body of the email.",
"type": "string"
},
"expire": {
"description": "The expiration date for the requestFile link. After this date, the link becomes unusable, though the files' expiry will follow the folder's settings.",
"type": "string",
"format": "date-time"
},
"count": {
"description": "The remaining number of uploads allowed. -1 represents unlimited uploads.",
"type": "integer"
},
"requireAuth": {
"description": "Indicates whether the uploader is required to sign in to upload files.",
"type": "boolean"
},
"actionId": {
"description": "Specifies the allowed actions for the uploader: 1 for viewing, 2 for downloading.",
"type": "integer",
"enum": [
"1",
"2"
]
},
"files": {
"description": "An array of file IDs that the requester may want to include, and available for uploaders to see or download.",
"type": "array",
"items": {
"type": "string"
}
},
"secureBody": {
"type": "boolean"
},
"addLinks": {
"description": "Indicates whether HATEOAS links should be included in the response",
"type": "boolean"
}
}
},
"NoteFile": {
"description": "Class NoteFile",
"required": [
"id",
"locked",
"name",
"parentId",
"size",
"type",
"userId",
"wopiapp"
],
"properties": {
"id": {
"description": "Unique identifier of object",
"type": "string"
},
"created": {
"description": "Date and time when the object was created",
"type": "string",
"format": "date-time"
},
"deleted": {
"description": "Indicates whether the object is deleted",
"type": "boolean"
},
"permDeleted": {
"description": "Indicates whether the object is permanently deleted",
"type": "boolean"
},
"expire": {
"description": "Date and time when the object expires and becomes inaccessible",
"type": "string",
"format": "date-time"
},
"modified": {
"description": "Date and time when the object was last modified",
"type": "string",
"format": "date-time"
},
"name": {
"description": "Display name of the object",
"type": "string"
},
"parentId": {
"description": "Parent Folder identifier",
"type": "string"
},
"userId": {
"description": "Unique identifier of Object creator",
"type": "string"
},
"parent": {
"description": "Folder that directly contains this object (Explicit field. May be retrieved only if mentioned in \"with\" parameter)",
"$ref": "#/components/schemas/Folder"
},
"permalink": {
"description": "Permanent URL for accessing the object in the web application",
"type": "string"
},
"creator": {
"description": "Basic profile information of the user who created the object (Explicit field. May be retrieved only if mentioned in \"with\" parameter)",
"$ref": "#/components/schemas/UserBasicInfo"
},
"permissions": {
"description": "Current user's permissions (Explicit field. May be retrieved only if mentioned in \"with\" parameter)",
"type": "array",
"items": {
"$ref": "#/components/schemas/Permission"
}
},
"vendorDocId": {
"description": "Identifier of the corresponding document in the external vendor system (Explicit field. May be retrieved only if mentioned in \"with\" parameter)",
"type": "string"
},
"vendorDocName": {
"description": "Display name of the corresponding document in the external vendor system (Explicit field. May be retrieved only if mentioned in \"with\" parameter)",
"type": "string"
},
"source": {
"description": "Numeric code identifying the external system that originated this object (e.g. Salesforce, Teams)",
"type": "integer"
},
"links": {
"description": "HATEOAS links associated with the entity",
"type": "array",
"items": {
"type": "string"
}
},
"mime": {
"description": "File MIME type",
"type": "string"
},
"size": {
"description": "Size of the file content in bytes",
"type": "string"
},
"fingerprint": {
"description": "Cryptographic fingerprint (hash) of the file content used for integrity verification",
"type": "string"
},
"tracking_id": {
"description": "File tracking ID (UUID)",
"type": "string"
},
"type": {
"type": "string"
},
"locked": {
"description": "Unique identifier of User who locked a File",
"type": "integer"
},
"lockUser": {
"description": "User who locked the File (Explicit field. May be retrieved only if mentioned in \"with\" parameter)",
"$ref": "#/components/schemas/User"
},
"clientCreated": {
"description": "Original created time of the file",
"type": "string",
"format": "date"
},
"clientModified": {
"description": "Original modified time of the file",
"type": "string",
"format": "date"
},
"members": {
"description": "File members list (Explicit field. May be retrieved only if mentioned in \"with\" parameter)",
"type": "array",
"items": {
"$ref": "#/components/schemas/Member"
}
},
"overriddenExpire": {
"description": "Indicates whether the file expiration date is overridden",
"type": "boolean"
},
"originalFileId": {
"description": "File identifier from which this file was copied from",
"type": "string"
},
"pushedObject": {
"description": "Contains pushedObject data if current file was ever pushed (Explicit field. May be retrieved only if mentioned in \"with\" parameter)",
"$ref": "#/components/schemas/PushedObject"
},
"avStatus": {
"description": "Check file availability status according to AV settings and file scanned/infected status",
"type": "string"
},
"dlpStatus": {
"description": "Check file availability status according to DLP settings and file scanned/infected status",
"type": "string"
},
"adminQuarantineStatus": {
"description": "Check file availability status according to admin quarantined status",
"type": "string"
},
"storageAvailable": {
"description": "Boolean value that shows if this file is available on any volume",
"type": "boolean"
},
"lastModifiedBy": {
"description": "Creator of the latest version (Explicit field. May be retrieved only if mentioned in \"with\" parameter)",
"$ref": "#/components/schemas/User"
},
"wopiapp": {
"description": "WOPI info for iOS app",
"type": "boolean"
},
"roleId": {
"description": "Highest role of the current user on this file",
"type": "string"
},
"isShared": {
"description": "Indicates whether the file is shared",
"type": "string"
},
"fingerprints": {
"description": "Array of file fingerprint objects",
"type": "array",
"items": {
"type": "string"
}
},
"tags": {
"description": "Array of tag objects",
"type": "array",
"items": {
"$ref": "#/components/schemas/Tag"
}
}
}
},
"NoteFile.Post": {
"description": "Class NoteFile",
"required": [
"name"
],
"properties": {
"addLinks": {
"description": "Indicates whether HATEOAS links should be included in the response",
"type": "boolean"
},
"name": {
"description": "Display name of the file",
"type": "string"
}
}
},
"NoteFile.Put": {
"description": "Class NoteFile",
"required": [
"name"
],
"properties": {
"addLinks": {
"description": "Indicates whether HATEOAS links should be included in the response",
"type": "boolean"
},
"name": {
"description": "Display name of the file",
"type": "string"
},
"expire": {
"description": "The file expiration date.",
"type": "string"
},
"replace": {
"description": "Replace the file if file with same name exists",
"type": "string"
}
}
},
"Kitepoint": {
"description": "Class Kitepoint",
"required": [
"id",
"name",
"parentId",
"size",
"userId"
],
"properties": {
"id": {
"description": "Unique identifier of object",
"type": "string"
},
"created": {
"description": "Date and time when the object was created",
"type": "string",
"format": "date-time"
},
"deleted": {
"description": "Indicates whether the object is deleted",
"type": "boolean"
},
"permDeleted": {
"description": "Indicates whether the object is permanently deleted",
"type": "boolean"
},
"expire": {
"description": "Date and time when the object expires and becomes inaccessible",
"type": "string",
"format": "date-time"
},
"modified": {
"description": "Date and time when the object was last modified",
"type": "string",
"format": "date-time"
},
"name": {
"description": "Display name of the object",
"type": "string"
},
"parentId": {
"description": "Parent Folder identifier",
"type": "string"
},
"userId": {
"description": "Unique identifier of Object creator",
"type": "string"
},
"parent": {
"description": "Folder that directly contains this object (Explicit field. May be retrieved only if mentioned in \"with\" parameter)",
"$ref": "#/components/schemas/Folder"
},
"permalink": {
"description": "Permanent URL for accessing the object in the web application",
"type": "string"
},
"creator": {
"description": "Basic profile information of the user who created the object (Explicit field. May be retrieved only if mentioned in \"with\" parameter)",
"$ref": "#/components/schemas/UserBasicInfo"
},
"permissions": {
"description": "Current user's permissions (Explicit field. May be retrieved only if mentioned in \"with\" parameter)",
"type": "array",
"items": {
"$ref": "#/components/schemas/Permission"
}
},
"vendorDocId": {
"description": "Identifier of the corresponding document in the external vendor system (Explicit field. May be retrieved only if mentioned in \"with\" parameter)",
"type": "string"
},
"vendorDocName": {
"description": "Display name of the corresponding document in the external vendor system (Explicit field. May be retrieved only if mentioned in \"with\" parameter)",
"type": "string"
},
"source": {
"description": "Numeric code identifying the external system that originated this object (e.g. Salesforce, Teams)",
"type": "integer"
},
"links": {
"description": "HATEOAS links associated with the entity",
"type": "array",
"items": {
"type": "string"
}
},
"mime": {
"description": "File MIME type",
"type": "string"
},
"size": {
"description": "Size of the file content in bytes",
"type": "string"
},
"fingerprint": {
"description": "Cryptographic fingerprint (hash) of the file content used for integrity verification",
"type": "string"
},
"tracking_id": {
"description": "File tracking ID (UUID)",
"type": "string"
},
"eCObject": {
"description": "EC object unique identifier of kitepoint file",
"$ref": "#/components/schemas/ECObject"
},
"type": {
"description": "Object type. Accepted values: `k` for kitepoint file in tray",
"type": "string"
},
"eCUUID": {
"description": "EC object universally unique identifier",
"type": "string"
}
}
},
"Kitepoint.Post": {
"description": "Class Kitepoint",
"properties": {
"addLinks": {
"description": "Indicates whether HATEOAS links should be included in the response",
"type": "boolean"
}
}
},
"Kitepoint.Put": {
"description": "Class Kitepoint",
"properties": {
"addLinks": {
"description": "Indicates whether HATEOAS links should be included in the response",
"type": "boolean"
}
}
},
"Comment": {
"description": "Class Comment",
"required": [
"contents",
"id",
"objectId",
"parentId",
"userId"
],
"properties": {
"id": {
"description": "Comment unique identifier",
"type": "integer"
},
"parentId": {
"description": "Unique identifier of the parent comment, if the comment is a reply",
"type": "integer"
},
"objectId": {
"description": "Unique identifier (UUID) of the file being commented on",
"type": "string"
},
"folderId": {
"description": "Unique identifier (UUID) of the folder containing the object being commented on",
"type": "string"
},
"userId": {
"description": "Unique identifier (UUID) of the user who authored the comment",
"type": "string"
},
"created": {
"description": "Date and time when the comment was created",
"type": "string",
"format": "date"
},
"modified": {
"description": "Date and time when the comment was last modified",
"type": "string",
"format": "date"
},
"contents": {
"description": "Text content of the comment",
"type": "string"
},
"deleted": {
"description": "Indicates whether the comment has been deleted",
"type": "boolean"
},
"isComment": {
"description": "Indicates whether the item is a comment",
"type": "boolean"
},
"object": {
"description": "File being commented on (Explicit field. May be retrieved only if mentioned in \"with\" parameter)",
"$ref": "#/components/schemas/BaseObject"
},
"author": {
"description": "Author of the comment (Explicit field. May be retrieved only if mentioned in \"with\" parameter)",
"$ref": "#/components/schemas/UserBasicInfo"
},
"parent": {
"description": "The comment this reply is responding to, if applicable (Explicit field. May be retrieved only if mentioned in \"with\" parameter)",
"$ref": "#/components/schemas/Comment"
},
"permissions": {
"description": "Permissions of the current user regarding the comment (Explicit field. May be retrieved only if mentioned in \"with\" parameter)",
"type": "array",
"items": {
"$ref": "#/components/schemas/Permission"
}
},
"links": {
"description": "HATEOAS links associated with the entity",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"Comment.Post": {
"description": "Class Comment",
"required": [
"contents"
],
"properties": {
"parentId": {
"description": "Unique identifier of the parent comment. Set this value when replying to an existing comment",
"type": "integer"
},
"contents": {
"description": "Text content of the comment",
"type": "string"
},
"addLinks": {
"description": "Indicates whether HATEOAS links should be included in the response",
"type": "boolean"
}
}
},
"Comment.Put": {
"description": "Class Comment",
"required": [
"contents"
],
"properties": {
"contents": {
"description": "Text content of the comment",
"type": "string"
},
"addLinks": {
"description": "Indicates whether HATEOAS links should be included in the response",
"type": "boolean"
}
}
},
"FeaturesList": {
"description": "Class FeaturesList",
"required": [
"allowedFolderRoles",
"folderCreate",
"storageQuota",
"sysFolderCreate",
"sysFolderDefaultQuota",
"sysFolderMaxCount",
"sysFolderMaxQuota"
],
"properties": {
"allowSftp": {
"description": "Indicates whether SFTP access is allowed",
"type": "boolean"
},
"maxStorage": {
"description": "Max storage in bytes",
"type": "integer"
},
"linkExpiration": {
"description": "Link expiration date in days",
"type": "integer"
},
"maxLinkExpiration": {
"description": "Max time period of link expiration in hours",
"type": "integer"
},
"setExpirationLower": {
"description": "Enable user to set expiration date of the file they are sending",
"type": "boolean"
},
"sendExternal": {
"description": "Allow user to send files to external users",
"type": "boolean"
},
"acNoAuth": {
"description": "Allow user to send file to a user without their having to authenticate",
"type": "boolean"
},
"folderCreate": {
"description": "Indicates whether the user is permitted to create top-level folders",
"type": "integer"
},
"allowedFolderRoles": {
"description": "Role options allowed for user profile",
"type": "array",
"items": {
"type": "string"
}
},
"sysFolderCreate": {
"description": "Indicates whether the user is permitted to create system quota folders",
"type": "integer"
},
"sysFolderMaxQuota": {
"description": "Max quota for a system quota folder",
"type": "integer"
},
"sysFolderMaxCount": {
"description": "Maximum number of system quota folder",
"type": "integer"
},
"sysFolderDefaultQuota": {
"description": "Default quota for a system quota folder",
"type": "integer"
},
"storageQuota": {
"description": "Maximum storage space allocated to the user, in bytes",
"type": "integer"
},
"ldapMapping": {
"description": "LDAP Mapping value to determine the user profile type",
"type": "string"
},
"acVerifyRecipient": {
"description": "Who can download file via the secure link",
"type": "boolean"
},
"acl": {
"description": "List of access control levels permitted for this user profile",
"type": "array",
"items": {
"type": "string"
}
},
"defaultAcl": {
"description": "Default access control level applied when sending files for this user profile",
"type": "string"
},
"mobileSyncItemsLimit": {
"description": "Maximum files amount allowed to keep in mobile sync list",
"type": "integer"
},
"personalFolder": {
"description": "User can have personal folder",
"type": "boolean"
},
"requireScanZipContentDefault": {
"description": "Indicates whether scanning compressed file content is required by default",
"type": "boolean"
},
"blockNewFileTypesDefault": {
"description": "Indicates whether new or unspecified file types are blocked by default",
"type": "boolean"
},
"excludedFileExtensions": {
"description": "Get list of excluded file extensions",
"type": "array",
"items": {
"type": "string"
}
},
"fileFilterExclusionGroups": {
"description": "Get list of excluded file groups",
"type": "array",
"items": {
"type": "string"
}
},
"fileFilterCustomFileTypes": {
"description": "Get list of custom file types",
"type": "array",
"items": {
"type": "string"
}
},
"secureMessageBody": {
"type": "string"
},
"secureMessageBodyDefault": {
"type": "boolean"
},
"secureContainerRequired": {
"type": "boolean"
},
"returnReceipt": {
"type": "string"
},
"returnReceiptDefault": {
"type": "boolean"
},
"selfCopy": {
"type": "string"
},
"selfCopyDefault": {
"type": "boolean"
},
"includeFingerprint": {
"type": "string"
},
"includeFingerprintDefault": {
"type": "boolean"
},
"requestFile": {
"type": "boolean"
},
"requestFileAllowViewableFile": {
"type": "boolean"
},
"requestFileUploadAuth": {
"type": "string"
},
"requestFileAuthDefault": {
"type": "string"
},
"requestFileExpiration": {
"type": "integer"
},
"requestFileExpirationUserDecide": {
"type": "boolean"
},
"requestFileExpirationMax": {
"type": "integer"
},
"requestFileUploadLimit": {
"type": "integer"
},
"requestFileUploadLimitUserDecide": {
"type": "boolean"
},
"requestFileUploadsMax": {
"type": "integer"
},
"twoFactorAuth": {
"type": "string"
},
"inactiveExpiration": {
"type": "integer"
},
"userCanReactivate": {
"type": "string"
},
"cleanupInactiveAccount": {
"type": "boolean"
},
"withdrawInactiveAccountFileLinks": {
"type": "boolean"
},
"allowCollaboration": {
"description": "Indicates whether Collaboration and Shared Folders are allowed",
"type": "boolean"
},
"allowLeavingSharedFolder": {
"description": "Indicates whether Collaboration and Shared Folders are allowed",
"type": "boolean"
},
"sendFileLimit": {
"description": "Upper limit allowed for number of attachments per mail.",
"type": "integer"
},
"remoteWipe": {
"type": "boolean"
},
"deleteUnsharedData": {
"type": "boolean"
},
"retainData": {
"type": "boolean"
},
"retainPermissionToSharedData": {
"type": "boolean"
},
"folderExpirationLimit": {
"description": "Get profile max folder expiration",
"type": "integer"
},
"fileLifetime": {
"description": "Get profile max file lifetime",
"type": "integer"
}
}
},
"FeaturesList.Post": {
"description": "Class FeaturesList",
"properties": {
"allowSftp": {
"description": "Indicates whether SFTP access is allowed",
"type": "boolean"
},
"maxStorage": {
"description": "Max storage in bytes",
"type": "integer"
},
"storageQuota": {
"description": "Maximum storage space that user is entitled to",
"type": "integer"
},
"setExpirationLower": {
"description": "Allow to modify file secure link expiration",
"type": "boolean"
},
"sendExternal": {
"description": "Allow sending files to external users",
"type": "integer"
},
"linkExpiration": {
"description": "Link expiration date in days",
"type": "integer"
},
"ldapMapping": {
"description": "LDAP Mapping value to determine the user profile type",
"type": "string"
},
"folderCreate": {
"description": "Allow to create top level folders",
"type": "integer"
},
"sysFolderCreate": {
"description": "Allow to create system quota folders",
"type": "integer"
},
"sysFolderMaxQuota": {
"description": "Set the maximum quota for a system folder",
"type": "integer"
},
"sysFolderMaxCount": {
"description": "Set the maximum number of system folders",
"type": "integer"
},
"sysFolderDefaultQuota": {
"description": "Set the default quota for a system folder",
"type": "integer"
},
"maxLinkExpiration": {
"description": "Upper limit allowed for secure link expiration",
"type": "integer"
},
"acNoAuth": {
"description": "Who can download file via the secure link",
"type": "boolean"
},
"acVerifyRecipient": {
"description": "Who can download file via the secure link",
"type": "boolean"
},
"excludedFileExtensions": {
"description": "Set excluded file extensions",
"type": "array",
"items": {
"type": "string"
}
},
"fileFilterExclusionGroups": {
"description": "Set excluded file groups",
"type": "array",
"items": {
"type": "string"
}
},
"fileFilterCustomFileTypes": {
"description": "Set custom file types",
"type": "array",
"items": {
"type": "string"
}
},
"secureMessageBody": {
"type": "string"
},
"secureMessageBodyDefault": {
"type": "boolean"
},
"secureContainerRequired": {
"type": "boolean"
},
"returnReceipt": {
"type": "string"
},
"returnReceiptDefault": {
"type": "boolean"
},
"selfCopy": {
"type": "string"
},
"selfCopyDefault": {
"type": "boolean"
},
"includeFingerprint": {
"type": "string"
},
"includeFingerprintDefault": {
"type": "boolean"
},
"requestFile": {
"type": "boolean"
},
"requestFileAllowViewableFile": {
"type": "boolean"
},
"requestFileUploadAuth": {
"type": "string"
},
"requestFileAuthDefault": {
"type": "string"
},
"requestFileExpiration": {
"type": "integer"
},
"requestFileExpirationUserDecide": {
"type": "boolean"
},
"requestFileExpirationMax": {
"type": "integer"
},
"requestFileUploadLimit": {
"type": "integer"
},
"requestFileUploadLimitUserDecide": {
"type": "boolean"
},
"requestFileUploadsMax": {
"type": "integer"
},
"twoFactorAuth": {
"type": "string"
},
"inactiveExpiration": {
"type": "integer"
},
"userCanReactivate": {
"type": "string"
},
"cleanupInactiveAccount": {
"type": "boolean"
},
"withdrawInactiveAccountFileLinks": {
"type": "boolean"
},
"allowCollaboration": {
"description": "Indicates whether Collaboration and Shared Folders are allowed",
"type": "boolean"
},
"sendFileLimit": {
"description": "Upper limit allowed for number of attachments per mail.",
"type": "integer"
},
"remoteWipe": {
"description": "Disallow Collaboration: Wipe remote devices",
"type": "boolean"
},
"deleteUnsharedData": {
"description": "Disallow Collaboration: Delete all data owned by the user",
"type": "boolean"
},
"retainData": {
"description": "Disallow Collaboration: retain the data owned by the user",
"type": "boolean"
},
"retainToUser": {
"description": "Disallow Collaboration: re-assign the data to the following user",
"type": "string"
},
"retainPermissionToSharedData": {
"description": "Disallow Collaboration: retain all permission to shared data",
"type": "boolean"
}
}
},
"FeaturesList.Put": {
"description": "Class FeaturesList",
"properties": {
"allowSftp": {
"description": "Indicates whether SFTP access is allowed",
"type": "boolean"
},
"maxStorage": {
"description": "Max storage in bytes",
"type": "integer"
},
"storageQuota": {
"description": "Maximum storage space that user is entitled to",
"type": "integer"
},
"setExpirationLower": {
"description": "Allow to modify file secure link expiration",
"type": "boolean"
},
"sendExternal": {
"description": "Allow sending files to external users",
"type": "integer"
},
"linkExpiration": {
"description": "Link expiration date in days",
"type": "integer"
},
"ldapMapping": {
"description": "LDAP Mapping value to determine the user profile type",
"type": "string"
},
"folderCreate": {
"description": "Allow to create top level folders",
"type": "integer"
},
"sysFolderCreate": {
"description": "Allow to create system quota folders",
"type": "integer"
},
"sysFolderMaxQuota": {
"description": "Set the maximum quota for a system folder",
"type": "integer"
},
"sysFolderMaxCount": {
"description": "Set the maximum number of system folders",
"type": "integer"
},
"sysFolderDefaultQuota": {
"description": "Set the default quota for a system folder",
"type": "integer"
},
"maxLinkExpiration": {
"description": "Upper limit allowed for secure link expiration",
"type": "integer"
},
"acNoAuth": {
"description": "Who can download file via the secure link",
"type": "boolean"
},
"acVerifyRecipient": {
"description": "Who can download file via the secure link",
"type": "boolean"
},
"excludedFileExtensions": {
"description": "Set excluded file extensions",
"type": "array",
"items": {
"type": "string"
}
},
"fileFilterExclusionGroups": {
"description": "Set excluded file groups",
"type": "array",
"items": {
"type": "string"
}
},
"fileFilterCustomFileTypes": {
"description": "Set custom file types",
"type": "array",
"items": {
"type": "string"
}
},
"secureMessageBody": {
"type": "string"
},
"secureMessageBodyDefault": {
"type": "boolean"
},
"secureContainerRequired": {
"type": "boolean"
},
"returnReceipt": {
"type": "string"
},
"returnReceiptDefault": {
"type": "boolean"
},
"selfCopy": {
"type": "string"
},
"selfCopyDefault": {
"type": "boolean"
},
"includeFingerprint": {
"type": "string"
},
"includeFingerprintDefault": {
"type": "boolean"
},
"requestFile": {
"type": "boolean"
},
"requestFileAllowViewableFile": {
"type": "boolean"
},
"requestFileUploadAuth": {
"type": "string"
},
"requestFileAuthDefault": {
"type": "string"
},
"requestFileExpiration": {
"type": "integer"
},
"requestFileExpirationUserDecide": {
"type": "boolean"
},
"requestFileExpirationMax": {
"type": "integer"
},
"requestFileUploadLimit": {
"type": "integer"
},
"requestFileUploadLimitUserDecide": {
"type": "boolean"
},
"requestFileUploadsMax": {
"type": "integer"
},
"twoFactorAuth": {
"type": "string"
},
"inactiveExpiration": {
"type": "integer"
},
"userCanReactivate": {
"type": "string"
},
"cleanupInactiveAccount": {
"type": "boolean"
},
"withdrawInactiveAccountFileLinks": {
"type": "boolean"
},
"allowCollaboration": {
"description": "Indicates whether Collaboration and Shared Folders are allowed",
"type": "boolean"
},
"sendFileLimit": {
"description": "Upper limit allowed for number of attachments per mail.",
"type": "integer"
},
"remoteWipe": {
"description": "Disallow Collaboration: Wipe remote devices",
"type": "boolean"
},
"deleteUnsharedData": {
"description": "Disallow Collaboration: Delete all data owned by the user",
"type": "boolean"
},
"retainData": {
"description": "Disallow Collaboration: retain the data owned by the user",
"type": "boolean"
},
"retainToUser": {
"description": "Disallow Collaboration: re-assign the data to the following user",
"type": "string"
},
"retainPermissionToSharedData": {
"description": "Disallow Collaboration: retain all permission to shared data",
"type": "boolean"
}
}
},
"Device": {
"description": "Class Device",
"required": [
"clientId",
"id",
"installName",
"userId"
],
"properties": {
"id": {
"description": "Unique identifier of Device",
"type": "integer"
},
"clientId": {
"description": "Unique identifier of client for this Device",
"type": "string"
},
"userId": {
"description": "Unique identifier of user for this Device",
"type": "string"
},
"installTagId": {
"description": "Unique identifier of the install tag for this device. Usually the serial number of the device",
"type": "string"
},
"installName": {
"description": "Install Tag name for this Device. e.g. Someone's IPhone",
"type": "string"
},
"wipeFlag": {
"description": "Flag that tells the device to remote wipe itself.\n * 0 = not set, 1 = set, 2 = device has been notified, 3 = wipe is completed",
"type": "string"
},
"mobileKeyStore": {
"description": "Key to encrypt files on this device",
"type": "string"
},
"links": {
"description": "HATEOAS links associated with the entity",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"Device.Post": {
"description": "Class Device",
"properties": {
"clientId": {
"description": "Unique identifier of client for this Device",
"type": "string"
},
"userId": {
"description": "Unique identifier of user for this Device",
"type": "string"
},
"installTagId": {
"description": "Unique identifier of the install tag for this device. Usually the serial number of the device",
"type": "string"
},
"installName": {
"description": "Install Tag name for this Device. e.g. Someone's IPhone",
"type": "string"
},
"mobileKeyStore": {
"description": "Key to encrypt files on this device",
"type": "string"
},
"addLinks": {
"description": "Indicates whether HATEOAS links should be included in the response",
"type": "boolean"
}
}
},
"Device.Put": {
"description": "Class Device",
"properties": {
"mobileKeyStore": {
"description": "Key to encrypt files on this device",
"type": "string"
},
"registrationToken": {
"description": "Set the token for messaging registration",
"type": "string"
},
"addLinks": {
"description": "Indicates whether HATEOAS links should be included in the response",
"type": "boolean"
}
}
},
"MobileSyncLink": {
"description": "Class ObjectLink",
"properties": {
"expire": {
"description": "Date and time after which the shortlink becomes invalid and can no longer be used",
"type": "string",
"format": "date"
},
"entityTypeId": {
"description": "Unique identifier of the entity type this shortlink is associated with",
"type": "integer"
},
"entityId": {
"description": "Unique identifier of the entity this shortlink points to, returned as a GUID from version 19 onwards",
"type": "string"
},
"entityTypeName": {
"description": "Human-readable name of the entity type this shortlink is associated with",
"type": "string"
},
"links": {
"description": "HATEOAS links associated with the entity",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"MobileSyncLink.Post": {
"description": "Class ObjectLink",
"properties": {
"ref": {
"description": "Shortlink handle. Example: abcdefg12",
"type": "string"
},
"expire": {
"description": "Date and time after which the shortlink becomes invalid and can no longer be used",
"type": "string",
"format": "date"
},
"entityTypeId": {
"description": "Unique identifier of entity type.\n * 1 = object,\n * 2 = email_package,\n * 3 = verification_code,\n * 4 = email_preview_package,\n * 5 = file_request,\n * 6 = add_file\n * 7 = password_reset,\n * 8 = gdrive_oauth,\n * 9 = connector_oauth,\n * 10 = comment,\n * 11 = task,\n * 12 = mobile_sync,\n * 13 = password_set,\n * 14 = event,\n * 15 = mail,\n * 16 = approval_request",
"type": "integer"
},
"entityId": {
"description": "Unique identifier of the entity this shortlink points to",
"type": "integer"
},
"length": {
"description": "Number of characters in the generated shortlink handle",
"type": "integer"
},
"addLinks": {
"description": "Indicates whether HATEOAS links should be included in the response",
"type": "boolean"
}
}
},
"MobileSyncLink.Put": {
"description": "Class ObjectLink",
"properties": {
"ref": {
"description": "Shortlink handle. Example: abcdefg12",
"type": "string"
},
"expire": {
"description": "Date and time after which the shortlink becomes invalid and can no longer be used",
"type": "string",
"format": "date"
},
"entityTypeId": {
"description": "Unique identifier of entity type.\n * 1 = object,\n * 2 = email_package,\n * 3 = verification_code,\n * 4 = email_preview_package,\n * 5 = file_request,\n * 6 = add_file\n * 7 = password_reset,\n * 8 = gdrive_oauth,\n * 9 = connector_oauth,\n * 10 = comment,\n * 11 = task,\n * 12 = mobile_sync,\n * 13 = password_set,\n * 14 = event,\n * 15 = mail,\n * 16 = approval_request",
"type": "integer"
},
"entityId": {
"description": "Unique identifier of the entity this shortlink points to",
"type": "integer"
},
"length": {
"description": "Number of characters in the generated shortlink handle",
"type": "integer"
},
"addLinks": {
"description": "Indicates whether HATEOAS links should be included in the response",
"type": "boolean"
}
}
},
"ContactItem": {
"type": "object",
"properties": {
"email": {
"type": "string",
"description": "Email address of the contact."
},
"isDistributionList": {
"type": "boolean",
"description": "Indicates whether the contact is a distribution list."
},
"profileIcon": {
"type": "string",
"description": "URL or identifier of the contact's profile icon."
}
}
},
"ContactItem.Post": {
"description": "Class ContactItem",
"required": [
"email"
],
"properties": {
"email": {
"description": "Contact's email address",
"type": "string"
},
"addLinks": {
"description": "Indicates whether HATEOAS links should be included in the response",
"type": "boolean"
}
}
},
"ContactItem.Put": {
"description": "Class ContactItem",
"required": [
"email"
],
"properties": {
"email": {
"description": "Contact's email address",
"type": "string"
},
"addLinks": {
"description": "Indicates whether HATEOAS links should be included in the response",
"type": "boolean"
}
}
},
"Favorite": {
"description": "Class Favorite",
"required": [
"id",
"objectId",
"userId"
],
"properties": {
"id": {
"description": "Unique identifier of Favorite",
"type": "integer"
},
"objectId": {
"description": "Unique identifier of the favorited folder or file",
"type": "string"
},
"userId": {
"description": "Unique identifier of the user who created this favorite",
"type": "string"
},
"creator": {
"description": "User who created this favorite (Explicit field. May be retrieved only if mentioned in \"with\" parameter)",
"$ref": "#/components/schemas/UserBasicInfo"
},
"object": {
"description": "Favorited folder object (Explicit field. May be retrieved only if mentioned in \"with\" parameter)",
"$ref": "#/components/schemas/Folder"
},
"links": {
"description": "HATEOAS links associated with the entity",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"Favorite.Post": {
"description": "Class Favorite",
"required": [
"objectId"
],
"properties": {
"objectId": {
"description": "Unique identifier of the favorited folder or file",
"type": "integer"
},
"addLinks": {
"description": "Indicates whether HATEOAS links should be included in the response",
"type": "boolean"
}
}
},
"Favorite.Put": {
"description": "Class Favorite",
"required": [
"objectId"
],
"properties": {
"objectId": {
"description": "Unique identifier of the favorited folder or file",
"type": "integer"
},
"addLinks": {
"description": "Indicates whether HATEOAS links should be included in the response",
"type": "boolean"
}
}
},
"Export": {
"description": "Class Export",
"required": [
"userId"
],
"properties": {
"id": {
"description": "Export task unique identifier",
"type": "string"
},
"startDate": {
"description": "Export start date",
"type": "string",
"format": "date"
},
"endDate": {
"description": "Export end date",
"type": "string",
"format": "date"
},
"status": {
"description": "Current status of the export. Accepted values: `inprocess`, `error`, `completed`, `nodata`",
"type": "string"
},
"downloadURL": {
"description": "URL for downloading the exported data",
"type": "string"
},
"type": {
"description": "Export type. Accepted values: `activities`, `files`, `emails`",
"type": "string"
},
"userId": {
"description": "Unique identifier of the user",
"type": "string"
},
"generatedDate": {
"description": "Date when the report was generated",
"type": "string",
"format": "date"
},
"fileName": {
"description": "Name of the generated export report file available for download",
"type": "string"
},
"links": {
"description": "HATEOAS links associated with the entity",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"Export.Post": {
"description": "Class Export",
"required": [
"startDate",
"endDate",
"types"
],
"properties": {
"startDate": {
"description": "Export start date",
"type": "string",
"format": "date"
},
"endDate": {
"description": "Export end date",
"type": "string",
"format": "date"
},
"types": {
"description": "Export type. Accepted values: `activities`, `files`, `emails`",
"type": "array",
"items": {
"type": "string"
}
},
"addLinks": {
"description": "Indicates whether HATEOAS links should be included in the response",
"type": "boolean"
}
}
},
"Export.Put": {
"description": "Class Export",
"required": [
"startDate",
"endDate",
"types"
],
"properties": {
"startDate": {
"description": "Export start date",
"type": "string",
"format": "date"
},
"endDate": {
"description": "Export end date",
"type": "string",
"format": "date"
},
"types": {
"description": "Export type. Accepted values: `activities`, `files`, `emails`",
"type": "array",
"items": {
"type": "string"
}
},
"addLinks": {
"description": "Indicates whether HATEOAS links should be included in the response",
"type": "boolean"
}
}
},
"SourceContent": {
"description": "Class SourceContent - if you need true EAPI entity use App\\Entity\\ECObject",
"required": [
"id",
"name",
"parentId",
"type",
"wopiapp"
],
"properties": {
"id": {
"description": "Unique SourceContent identifier",
"type": "string"
},
"name": {
"description": "Display name of the source content item",
"type": "string"
},
"parentId": {
"description": "Parent source content unique identifier",
"type": "string"
},
"type": {
"description": "Source content type. Accepted values: \\`d\\` (folder), \\`f\\` (file)",
"type": "string"
},
"created": {
"description": "Creation timestamp of the source content in UTC",
"type": "string",
"format": "date"
},
"modified": {
"description": "Last modification timestamp of the source content in UTC",
"type": "string",
"format": "date"
},
"status": {
"description": "Current availability status of the source content item",
"type": "string"
},
"deleted": {
"description": "Indicates whether the source content is deleted",
"type": "boolean"
},
"path": {
"description": "Full path of the source content",
"type": "string"
},
"userRoleId": {
"description": "Current user role id (Explicit field. May be retrieved only if mentioned in \"with\" parameter)",
"type": "integer"
},
"creator": {
"description": "File's creator (Explicit field. May be retrieved only if mentioned in \"with\" parameter)",
"$ref": "#/components/schemas/UserBasicInfo"
},
"permissions": {
"description": "Current user's permissions (Explicit field. May be retrieved only if mentioned in \"with\" parameter)",
"type": "array",
"items": {
"$ref": "#/components/schemas/Permission"
}
},
"wopiapp": {
"description": "WOPI info for iOS app",
"type": "boolean"
},
"rootId": {
"description": "Unique identifier of the root-level source content ancestor (Explicit field. May be retrieved only if mentioned in \"with\" parameter)",
"type": "string"
},
"pathIds": {
"description": "Ordered list of ancestor identifiers representing the full path from root to this source content item (Explicit field. May be retrieved only if mentioned in \"with\" parameter)",
"type": "string"
},
"sourceTypeId": {
"description": "Unique identifier of the ECM source type this content belongs to (Explicit field. May be retrieved only if mentioned in \"with\" parameter)",
"type": "string"
},
"totalFilesCount": {
"description": "Total number of files in the source content (Explicit field. May be retrieved only if mentioned in \"with\" parameter)",
"type": "string"
},
"totalFoldersCount": {
"description": "Total number of folders in the source content (Explicit field. May be retrieved only if mentioned in \"with\" parameter)",
"type": "string"
},
"parent": {
"description": "Parent source content item (Explicit field. May be retrieved only if mentioned in \"with\" parameter)",
"$ref": "#/components/schemas/SourceContent"
},
"links": {
"description": "HATEOAS links associated with the entity",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"SourceContent.Post": {
"description": "Class SourceContent - if you need true EAPI entity use App\\Entity\\ECObject",
"properties": {
"id": {
"description": "Unique SourceContent identifier",
"type": "string"
},
"addLinks": {
"description": "Indicates whether HATEOAS links should be included in the response",
"type": "boolean"
}
}
},
"SourceContent.Put": {
"description": "Class SourceContent - if you need true EAPI entity use App\\Entity\\ECObject",
"properties": {
"id": {
"description": "Unique SourceContent identifier",
"type": "string"
},
"addLinks": {
"description": "Indicates whether HATEOAS links should be included in the response",
"type": "boolean"
}
}
},
"KitepointFile": {
"description": "Class File",
"required": [
"id",
"locked",
"name",
"parentId",
"size",
"type",
"userId",
"wopiapp"
],
"properties": {
"id": {
"description": "Unique identifier of object",
"type": "string"
},
"created": {
"description": "Date and time when the object was created",
"type": "string",
"format": "date-time"
},
"deleted": {
"description": "Indicates whether the object is deleted",
"type": "boolean"
},
"permDeleted": {
"description": "Indicates whether the object is permanently deleted",
"type": "boolean"
},
"expire": {
"description": "Date and time when the object expires and becomes inaccessible",
"type": "string",
"format": "date-time"
},
"modified": {
"description": "Date and time when the object was last modified",
"type": "string",
"format": "date-time"
},
"name": {
"description": "Display name of the object",
"type": "string"
},
"parentId": {
"description": "Parent Folder identifier",
"type": "string"
},
"userId": {
"description": "Unique identifier of Object creator",
"type": "string"
},
"parent": {
"description": "Folder that directly contains this object (Explicit field. May be retrieved only if mentioned in \"with\" parameter)",
"$ref": "#/components/schemas/Folder"
},
"permalink": {
"description": "Permanent URL for accessing the object in the web application",
"type": "string"
},
"creator": {
"description": "Basic profile information of the user who created the object (Explicit field. May be retrieved only if mentioned in \"with\" parameter)",
"$ref": "#/components/schemas/UserBasicInfo"
},
"permissions": {
"description": "Current user's permissions (Explicit field. May be retrieved only if mentioned in \"with\" parameter)",
"type": "array",
"items": {
"$ref": "#/components/schemas/Permission"
}
},
"vendorDocId": {
"description": "Identifier of the corresponding document in the external vendor system (Explicit field. May be retrieved only if mentioned in \"with\" parameter)",
"type": "string"
},
"vendorDocName": {
"description": "Display name of the corresponding document in the external vendor system (Explicit field. May be retrieved only if mentioned in \"with\" parameter)",
"type": "string"
},
"source": {
"description": "Numeric code identifying the external system that originated this object (e.g. Salesforce, Teams)",
"type": "integer"
},
"links": {
"description": "HATEOAS links associated with the entity",
"type": "array",
"items": {
"type": "string"
}
},
"mime": {
"description": "File MIME type",
"type": "string"
},
"size": {
"description": "Size of the file content in bytes",
"type": "string"
},
"fingerprint": {
"description": "Cryptographic fingerprint (hash) of the file content used for integrity verification",
"type": "string"
},
"tracking_id": {
"description": "File tracking ID (UUID)",
"type": "string"
},
"type": {
"type": "string"
},
"locked": {
"description": "Unique identifier of User who locked a File",
"type": "integer"
},
"lockUser": {
"description": "User who locked the File (Explicit field. May be retrieved only if mentioned in \"with\" parameter)",
"$ref": "#/components/schemas/User"
},
"clientCreated": {
"description": "Original created time of the file",
"type": "string",
"format": "date"
},
"clientModified": {
"description": "Original modified time of the file",
"type": "string",
"format": "date"
},
"members": {
"description": "File members list (Explicit field. May be retrieved only if mentioned in \"with\" parameter)",
"type": "array",
"items": {
"$ref": "#/components/schemas/Member"
}
},
"overriddenExpire": {
"description": "Indicates whether the file expiration date is overridden",
"type": "boolean"
},
"originalFileId": {
"description": "File identifier from which this file was copied from",
"type": "string"
},
"pushedObject": {
"description": "Contains pushedObject data if current file was ever pushed (Explicit field. May be retrieved only if mentioned in \"with\" parameter)",
"$ref": "#/components/schemas/PushedObject"
},
"avStatus": {
"description": "Check file availability status according to AV settings and file scanned/infected status",
"type": "string"
},
"dlpStatus": {
"description": "Check file availability status according to DLP settings and file scanned/infected status",
"type": "string"
},
"adminQuarantineStatus": {
"description": "Check file availability status according to admin quarantined status",
"type": "string"
},
"storageAvailable": {
"description": "Boolean value that shows if this file is available on any volume",
"type": "boolean"
},
"lastModifiedBy": {
"description": "Creator of the latest version (Explicit field. May be retrieved only if mentioned in \"with\" parameter)",
"$ref": "#/components/schemas/User"
},
"wopiapp": {
"description": "WOPI info for iOS app",
"type": "boolean"
},
"roleId": {
"description": "Highest role of the current user on this file",
"type": "string"
},
"isShared": {
"description": "Indicates whether the file is shared",
"type": "string"
},
"fingerprints": {
"description": "Array of file fingerprint objects",
"type": "array",
"items": {
"type": "string"
}
},
"tags": {
"description": "Array of tag objects",
"type": "array",
"items": {
"$ref": "#/components/schemas/Tag"
}
}
}
},
"KitepointFile.Post": {
"description": "Class File",
"required": [
"name"
],
"properties": {
"addLinks": {
"description": "Indicates whether HATEOAS links should be included in the response",
"type": "boolean"
},
"name": {
"description": "Display name of the file",
"type": "string"
}
}
},
"KitepointFile.Put": {
"description": "Class File",
"required": [
"name"
],
"properties": {
"addLinks": {
"description": "Indicates whether HATEOAS links should be included in the response",
"type": "boolean"
},
"name": {
"description": "Display name of the file",
"type": "string"
},
"expire": {
"description": "The file expiration date.",
"type": "string"
},
"replace": {
"description": "Replace the file if file with same name exists",
"type": "string"
}
}
},
"Tenant": {
"description": "Class Tenant",
"required": [
"id",
"name"
],
"properties": {
"id": {
"description": "Tenant unique identifier",
"type": "integer"
},
"name": {
"description": "Display name of the tenant",
"type": "string"
},
"hostname": {
"description": "Hostname used to access the tenant",
"type": "string"
},
"created": {
"description": "Date and time the tenant was created",
"type": "string",
"format": "date"
},
"state": {
"description": "Tenant state. Accepted values: `run`, `suspend`",
"type": "string"
},
"customerId": {
"description": "Customer unique identifier",
"type": "string"
},
"deploymentId": {
"description": "Deployment unique identifier",
"type": "string"
},
"expires": {
"description": "Date and time the tenant licence expires",
"type": "string",
"format": "date"
},
"storageLimit": {
"description": "Monthly storage usage limit in bytes",
"type": "integer"
},
"bandwidthLimit": {
"description": "Monthly bandwidth usage limit in bytes",
"type": "integer"
},
"primaryAdminEmail": {
"description": "Primary administrator email address",
"type": "string"
},
"licensedUsersCount": {
"description": "Number of licensed users",
"type": "integer"
},
"links": {
"description": "HATEOAS links associated with the entity",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"Tenant.Post": {
"description": "Class Tenant",
"properties": {
"addLinks": {
"description": "Indicates whether HATEOAS links should be included in the response",
"type": "boolean"
}
}
},
"Tenant.Put": {
"description": "Class Tenant",
"properties": {
"state": {
"description": "Tenant state. Accepted values: `run`, `suspend`",
"type": "string",
"enum": [
"run",
"suspend"
]
},
"addLinks": {
"description": "Indicates whether HATEOAS links should be included in the response",
"type": "boolean"
}
}
},
"User": {
"description": "Class User",
"required": [
"basedirId",
"email",
"id",
"mydirId",
"name",
"syncdirId"
],
"properties": {
"id": {
"description": "The unique identifier of the user",
"type": "string"
},
"basedirId": {
"description": "The unique identifier of the user's root Kiteworks directory.",
"type": "string"
},
"created": {
"description": "Date and time the user account was created",
"type": "string",
"format": "date"
},
"email": {
"description": "The user's email",
"type": "string"
},
"mydirId": {
"description": "The unique identifier of the user's mydir system directory.",
"type": "string"
},
"name": {
"description": "The name of the user",
"type": "string"
},
"syncdirId": {
"description": "The unique identifier of the user's 'My Folder'.",
"type": "string"
},
"userTypeId": {
"description": "The unique identifier of the user type (profile).",
"type": "integer"
},
"internal": {
"description": "Indicates whether the user is an internal user",
"type": "boolean"
},
"profileIcon": {
"description": "URL to the user's profile icon image",
"type": "string"
},
"extDL": {
"description": "Indicates whether the user is an External Distribution List",
"type": "boolean"
},
"metadata": {
"description": "List of user's metadata",
"type": "array",
"items": {
"$ref": "#/components/schemas/UserMetadata"
}
},
"adminRoleId": {
"description": "The ID of the admin role assigned to the user.",
"type": "integer"
},
"links": {
"description": "HATEOAS links associated with the entity",
"type": "array",
"items": {
"type": "string"
}
},
"active": {
"description": "Indicates whether the user is an actual kitework user",
"type": "boolean"
},
"suspended": {
"description": "Indicates whether the user is suspended",
"type": "boolean"
},
"deleted": {
"description": "Indicates whether the user has been deleted",
"type": "boolean"
},
"flags": {
"description": "Authentication type.\n * 0: No authentication,\n * 1: Authentication by kiteworks,\n * 2: Authentication by LDAP,\n * 4: Authentication by SSO",
"type": "integer"
},
"verified": {
"description": "Indicates whether the user is verified",
"type": "boolean"
},
"deactivated": {
"description": "Indicates whether the user has been deactivated",
"type": "boolean"
},
"lastActivityDateTime": {
"description": "User's last activity datetime",
"type": "string",
"format": "date"
},
"passwordExpirationDateTime": {
"description": "The exact timestamp when the user's password will expire",
"type": "string",
"format": "date"
}
}
},
"User.Post": {
"description": "Class User",
"required": [
"email"
],
"properties": {
"email": {
"description": "The user's email",
"type": "string"
},
"name": {
"description": "The name of the user",
"type": "string"
},
"password": {
"description": "The user's password",
"type": "string"
},
"userTypeId": {
"description": "The unique identifier of the user type",
"type": "integer"
},
"verified": {
"description": "Indicates whether the user is verified",
"type": "boolean"
},
"sendNotification": {
"description": "Indicates whether a notification is sent to the user",
"type": "boolean"
},
"addLinks": {
"description": "Indicates whether HATEOAS links should be included in the response",
"type": "boolean"
}
}
},
"User.Put": {
"description": "Class User",
"properties": {
"suspended": {
"description": "Indicates whether the user is suspended. Set to true to suspend the user.",
"type": "boolean"
},
"name": {
"description": "The name of the user",
"type": "string"
},
"password": {
"description": "The user's password",
"type": "string"
},
"verified": {
"description": "Indicates whether the user is verified",
"type": "boolean"
},
"deactivated": {
"description": "Indicates whether the user is deactivated. Set to true to deactivate the user.",
"type": "boolean"
},
"addLinks": {
"description": "Indicates whether HATEOAS links should be included in the response",
"type": "boolean"
}
}
},
"RequestFileSource": {
"description": "Class RequestFileSource",
"properties": {
"fileId": {
"description": "The unique identifier of the source file",
"type": "integer"
},
"requestFileId": {
"description": "The unique identifier of the associated request file",
"type": "integer"
},
"actionId": {
"description": "The available permissions on the source file for the uploader",
"type": "integer"
},
"permissions": {
"description": "Request file permissions for the source file",
"type": "array",
"items": {
"$ref": "#/components/schemas/RequestFilePermission"
}
}
}
},
"RiskPolicyFormFile": {
"description": "Class RiskPolicyFormFile",
"required": [
"id",
"locked",
"name",
"parentId",
"size",
"type",
"userId",
"wopiapp"
],
"properties": {
"id": {
"description": "Unique identifier of object",
"type": "string"
},
"created": {
"description": "Date and time when the object was created",
"type": "string",
"format": "date-time"
},
"deleted": {
"description": "Indicates whether the object is deleted",
"type": "boolean"
},
"permDeleted": {
"description": "Indicates whether the object is permanently deleted",
"type": "boolean"
},
"expire": {
"description": "Date and time when the object expires and becomes inaccessible",
"type": "string",
"format": "date-time"
},
"modified": {
"description": "Date and time when the object was last modified",
"type": "string",
"format": "date-time"
},
"name": {
"description": "Display name of the object",
"type": "string"
},
"parentId": {
"description": "Parent Folder identifier",
"type": "string"
},
"userId": {
"description": "Unique identifier of Object creator",
"type": "string"
},
"parent": {
"description": "Folder that directly contains this object (Explicit field. May be retrieved only if mentioned in \"with\" parameter)",
"$ref": "#/components/schemas/Folder"
},
"permalink": {
"description": "Permanent URL for accessing the object in the web application",
"type": "string"
},
"creator": {
"description": "Basic profile information of the user who created the object (Explicit field. May be retrieved only if mentioned in \"with\" parameter)",
"$ref": "#/components/schemas/UserBasicInfo"
},
"permissions": {
"description": "Current user's permissions (Explicit field. May be retrieved only if mentioned in \"with\" parameter)",
"type": "array",
"items": {
"$ref": "#/components/schemas/Permission"
}
},
"vendorDocId": {
"description": "Identifier of the corresponding document in the external vendor system (Explicit field. May be retrieved only if mentioned in \"with\" parameter)",
"type": "string"
},
"vendorDocName": {
"description": "Display name of the corresponding document in the external vendor system (Explicit field. May be retrieved only if mentioned in \"with\" parameter)",
"type": "string"
},
"source": {
"description": "Numeric code identifying the external system that originated this object (e.g. Salesforce, Teams)",
"type": "integer"
},
"links": {
"description": "HATEOAS links associated with the entity",
"type": "array",
"items": {
"type": "string"
}
},
"mime": {
"description": "File MIME type",
"type": "string"
},
"size": {
"description": "Size of the file content in bytes",
"type": "string"
},
"fingerprint": {
"description": "Cryptographic fingerprint (hash) of the file content used for integrity verification",
"type": "string"
},
"tracking_id": {
"description": "File tracking ID (UUID)",
"type": "string"
},
"type": {
"type": "string"
},
"locked": {
"description": "Unique identifier of User who locked a File",
"type": "integer"
},
"lockUser": {
"description": "User who locked the File (Explicit field. May be retrieved only if mentioned in \"with\" parameter)",
"$ref": "#/components/schemas/User"
},
"clientCreated": {
"description": "Original created time of the file",
"type": "string",
"format": "date"
},
"clientModified": {
"description": "Original modified time of the file",
"type": "string",
"format": "date"
},
"members": {
"description": "File members list (Explicit field. May be retrieved only if mentioned in \"with\" parameter)",
"type": "array",
"items": {
"$ref": "#/components/schemas/Member"
}
},
"overriddenExpire": {
"description": "Indicates whether the file expiration date is overridden",
"type": "boolean"
},
"originalFileId": {
"description": "File identifier from which this file was copied from",
"type": "string"
},
"pushedObject": {
"description": "Contains pushedObject data if current file was ever pushed (Explicit field. May be retrieved only if mentioned in \"with\" parameter)",
"$ref": "#/components/schemas/PushedObject"
},
"avStatus": {
"description": "Check file availability status according to AV settings and file scanned/infected status",
"type": "string"
},
"dlpStatus": {
"description": "Check file availability status according to DLP settings and file scanned/infected status",
"type": "string"
},
"adminQuarantineStatus": {
"description": "Check file availability status according to admin quarantined status",
"type": "string"
},
"storageAvailable": {
"description": "Boolean value that shows if this file is available on any volume",
"type": "boolean"
},
"lastModifiedBy": {
"description": "Creator of the latest version (Explicit field. May be retrieved only if mentioned in \"with\" parameter)",
"$ref": "#/components/schemas/User"
},
"wopiapp": {
"description": "WOPI info for iOS app",
"type": "boolean"
},
"roleId": {
"description": "Highest role of the current user on this file",
"type": "string"
},
"isShared": {
"description": "Indicates whether the file is shared",
"type": "string"
},
"fingerprints": {
"description": "Array of file fingerprint objects",
"type": "array",
"items": {
"type": "string"
}
},
"tags": {
"description": "Array of tag objects",
"type": "array",
"items": {
"$ref": "#/components/schemas/Tag"
}
}
}
},
"RiskPolicyFormFile.Post": {
"description": "Class RiskPolicyFormFile",
"required": [
"name"
],
"properties": {
"addLinks": {
"description": "Indicates whether HATEOAS links should be included in the response",
"type": "boolean"
},
"name": {
"description": "Display name of the file",
"type": "string"
}
}
},
"RiskPolicyFormFile.Put": {
"description": "Class RiskPolicyFormFile",
"required": [
"name"
],
"properties": {
"addLinks": {
"description": "Indicates whether HATEOAS links should be included in the response",
"type": "boolean"
},
"name": {
"description": "Display name of the file",
"type": "string"
},
"expire": {
"description": "The file expiration date.",
"type": "string"
},
"replace": {
"description": "Replace the file if file with same name exists",
"type": "string"
}
}
},
"ActivityAdmin": {
"description": "Class Activity",
"required": [
"event",
"id",
"message",
"type",
"user"
],
"properties": {
"created": {
"description": "Activity creation date",
"type": "string",
"format": "date"
},
"data": {
"description": "Contains information about affected entities",
"type": "array",
"items": {
"type": "string"
}
},
"permissions": {
"description": "List of actions allowed for the user on the object in the activity",
"type": "array",
"items": {
"type": "string"
}
},
"event": {
"description": "Activity event name",
"type": "string"
},
"id": {
"description": "Unique Activity identifier",
"type": "integer"
},
"message": {
"description": "User-friendly message",
"type": "string"
},
"type": {
"description": "Activity type. Accepted values: `folder_changes`, `file_changes`, `user_preferences`, `mail`, `tasks`, `comments`, `kitepoint`, `admin`",
"type": "string"
},
"user": {
"description": "User associated with the activity",
"type": "string"
},
"successful": {
"description": "Indicates whether the activity was successful",
"type": "integer"
},
"object": {
"description": "Contains information about the affected file or folder",
"type": "array",
"items": {
"type": "string"
}
},
"directUser": {
"description": "Direct user associated with the activity",
"type": "array",
"items": {
"type": "string"
}
},
"inDirectUsers": {
"description": "Indirect users associated with the activity",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"BaseNotification": {
"description": "Class Notification",
"properties": {
"objectId": {
"description": "Unique identifier of the folder included in the notification",
"type": "string"
},
"fileAdded": {
"description": "Number of files added to the notification",
"type": "integer"
},
"commentAdded": {
"description": "Number of comments added to the notification",
"type": "integer"
},
"links": {
"description": "HATEOAS links associated with the entity",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"BaseNotification.Post": {
"description": "Class Notification",
"properties": {
"fileAdded": {
"description": "Number of files added to the notification",
"type": "integer"
},
"commentAdded": {
"description": "Number of comments added to the notification",
"type": "integer"
},
"addLinks": {
"description": "Indicates whether HATEOAS links should be included in the response",
"type": "boolean"
}
}
},
"BaseNotification.Put": {
"description": "Class Notification",
"properties": {
"fileAdded": {
"description": "Number of files added to the notification",
"type": "integer"
},
"commentAdded": {
"description": "Number of comments added to the notification",
"type": "integer"
},
"addLinks": {
"description": "Indicates whether HATEOAS links should be included in the response",
"type": "boolean"
}
}
},
"Job": {
"properties": {
"id": {
"description": "Job unique identifier",
"type": "string"
},
"status": {
"description": "Current job status. Accepted values: `queued`, `working`, `succeeded`, `failed`",
"type": "string"
},
"errors": {
"description": "List of errors that occurred during job processing",
"type": "string"
},
"objectIds": {
"description": "List of object IDs associated with this job",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"MemberGroup": {
"description": "Class MemberGroup",
"required": [
"groupId",
"objectId",
"roleId"
],
"properties": {
"objectId": {
"description": "Unique identifier of the folder this member belongs to",
"type": "string"
},
"roleId": {
"description": "Unique identifier of the role assigned to this member",
"type": "integer"
},
"group": {
"description": "Details of the LDAP group that is a member (Explicit field. May be retrieved only if mentioned in \"with\" parameter)",
"$ref": "#/components/schemas/LdapGroup"
},
"role": {
"description": "Details of the role assigned to this member (Explicit field. May be retrieved only if mentioned in \"with\" parameter)",
"$ref": "#/components/schemas/Role"
},
"inheritRoleId": {
"description": "Unique identifier of the role inherited from the parent folder (Explicit field. May be retrieved only if mentioned in \"with\" parameter)",
"type": "integer"
},
"allowedFolderRoleId": {
"description": "List of role identifiers that are permitted for this folder membership (Explicit field. May be retrieved only if mentioned in \"with\" parameter)",
"type": "array",
"items": {
"type": "string"
}
},
"links": {
"description": "HATEOAS links associated with the entity",
"type": "array",
"items": {
"type": "string"
}
},
"groupId": {
"description": "Unique identifier of the LDAP group assigned as a member",
"type": "integer"
},
"user": {
"description": "Details of the user who is a member (Explicit field. May be retrieved only if mentioned in \"with\" parameter)",
"$ref": "#/components/schemas/User"
}
}
},
"MemberGroup.Post": {
"description": "Class MemberGroup",
"required": [
"groupId",
"roleId"
],
"properties": {
"roleId": {
"description": "Unique identifier of the role to assign to this member",
"type": "integer"
},
"addLinks": {
"description": "Indicates whether HATEOAS links should be included in the response",
"type": "boolean"
},
"groupId": {
"description": "Unique identifier of the LDAP group assigned as a member",
"type": "integer"
}
}
},
"MemberGroup.Put": {
"description": "Class MemberGroup",
"required": [
"roleId"
],
"properties": {
"roleId": {
"description": "Unique identifier of the role to assign to this member",
"type": "integer"
},
"notifyFileAdded": {
"description": "Indicates whether the member should be notified when a file is added",
"type": "boolean"
},
"addLinks": {
"description": "Indicates whether HATEOAS links should be included in the response",
"type": "boolean"
}
}
},
"MediaTypeItem": {
"description": "Class MediaTypeItem",
"required": [
"id",
"mediaType"
],
"properties": {
"id": {
"description": "Media type unique identifier",
"type": "integer"
},
"mediaType": {
"description": "Media type name",
"type": "string"
},
"links": {
"description": "HATEOAS links associated with the entity",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"MediaTypeItem.Post": {
"description": "Class MediaTypeItem",
"properties": {
"addLinks": {
"description": "Indicates whether HATEOAS links should be included in the response",
"type": "boolean"
}
}
},
"MediaTypeItem.Put": {
"description": "Class MediaTypeItem",
"properties": {
"addLinks": {
"description": "Indicates whether HATEOAS links should be included in the response",
"type": "boolean"
}
}
},
"WebFormProfile": {
"type": "object",
"properties": {
"webFormId": {
"type": "string",
"description": "Unique identifier of the web form."
},
"profileId": {
"type": "integer",
"description": "Unique identifier of the user profile associated with the web form."
}
}
},
"RequestFileLink": {
"description": "Class RequestFileLink",
"properties": {
"expire": {
"description": "Date and time after which the shortlink becomes invalid and can no longer be used",
"type": "string",
"format": "date"
},
"entityTypeId": {
"description": "Unique identifier of the entity type this shortlink is associated with",
"type": "integer"
},
"entityId": {
"description": "Unique identifier of the entity this shortlink points to, returned as a GUID from version 19 onwards",
"type": "string"
},
"entityTypeName": {
"description": "Human-readable name of the entity type this shortlink is associated with",
"type": "string"
},
"links": {
"description": "HATEOAS links associated with the entity",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"RequestFileLink.Post": {
"description": "Class RequestFileLink",
"properties": {
"ref": {
"description": "Shortlink handle. Example: abcdefg12",
"type": "string"
},
"expire": {
"description": "Date and time after which the shortlink becomes invalid and can no longer be used",
"type": "string",
"format": "date"
},
"entityTypeId": {
"description": "Unique identifier of entity type.\n * 1 = object,\n * 2 = email_package,\n * 3 = verification_code,\n * 4 = email_preview_package,\n * 5 = file_request,\n * 6 = add_file\n * 7 = password_reset,\n * 8 = gdrive_oauth,\n * 9 = connector_oauth,\n * 10 = comment,\n * 11 = task,\n * 12 = mobile_sync,\n * 13 = password_set,\n * 14 = event,\n * 15 = mail,\n * 16 = approval_request",
"type": "integer"
},
"entityId": {
"description": "Unique identifier of the entity this shortlink points to",
"type": "integer"
},
"length": {
"description": "Number of characters in the generated shortlink handle",
"type": "integer"
},
"addLinks": {
"description": "Indicates whether HATEOAS links should be included in the response",
"type": "boolean"
}
}
},
"RequestFileLink.Put": {
"description": "Class RequestFileLink",
"properties": {
"ref": {
"description": "Shortlink handle. Example: abcdefg12",
"type": "string"
},
"expire": {
"description": "Date and time after which the shortlink becomes invalid and can no longer be used",
"type": "string",
"format": "date"
},
"entityTypeId": {
"description": "Unique identifier of entity type.\n * 1 = object,\n * 2 = email_package,\n * 3 = verification_code,\n * 4 = email_preview_package,\n * 5 = file_request,\n * 6 = add_file\n * 7 = password_reset,\n * 8 = gdrive_oauth,\n * 9 = connector_oauth,\n * 10 = comment,\n * 11 = task,\n * 12 = mobile_sync,\n * 13 = password_set,\n * 14 = event,\n * 15 = mail,\n * 16 = approval_request",
"type": "integer"
},
"entityId": {
"description": "Unique identifier of the entity this shortlink points to",
"type": "integer"
},
"length": {
"description": "Number of characters in the generated shortlink handle",
"type": "integer"
},
"addLinks": {
"description": "Indicates whether HATEOAS links should be included in the response",
"type": "boolean"
}
}
},
"DailyBandwidth": {
"description": "Class DailyBandwidth",
"properties": {
"dateTime": {
"description": "Bandwidth measurement date and time",
"type": "string",
"format": "date"
},
"eventStatus": {
"description": "Event status. Accepted values: `1` (upload), `2` (download)",
"type": "integer"
},
"usage": {
"description": "Bandwidth usage in bytes",
"type": "integer"
}
}
},
"Search": {
"description": "Class Search",
"required": [
"emails",
"files",
"folders",
"id"
],
"properties": {
"files": {
"description": "List of files",
"type": "array",
"items": {
"$ref": "#/components/schemas/File"
}
},
"folders": {
"description": "List of folders",
"type": "array",
"items": {
"$ref": "#/components/schemas/Folder"
}
},
"emails": {
"description": "List of emails",
"type": "array",
"items": {
"$ref": "#/components/schemas/Email"
}
},
"metadata": {
"description": "Total files, folders, and emails count",
"$ref": "#/components/schemas/SearchMetadata"
},
"id": {
"description": "Search unique identifier",
"type": "string"
},
"fullTextSearch": {
"description": "Indicates whether full text search is enabled",
"type": "boolean"
}
}
},
"Activity": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "Unique identifier of the activity event."
},
"created": {
"type": "string",
"format": "date",
"description": "Date and time when the activity event was recorded."
},
"event": {
"type": "string",
"description": "Name of the activity event."
},
"message": {
"type": "string",
"description": "Human-readable summary of the activity event."
},
"type": {
"type": "string",
"description": "Type category of the activity event."
},
"successful": {
"type": "boolean",
"description": "Indicates whether the activity completed successfully."
},
"user": {
"description": "Details of the user who performed the activity.",
"allOf": [
{
"$ref": "#/components/schemas/ActivityUser"
}
]
},
"permissions": {
"type": "array",
"description": "List of permissions required for the activity.",
"items": {
"type": "string"
}
},
"data": {
"readOnly": true,
"description": "Additional event-specific data associated with the activity."
}
}
},
"EmailFormFile": {
"description": "Class EmailFormFile",
"required": [
"id",
"locked",
"name",
"parentId",
"size",
"type",
"userId",
"wopiapp"
],
"properties": {
"id": {
"description": "Unique identifier of object",
"type": "string"
},
"created": {
"description": "Date and time when the object was created",
"type": "string",
"format": "date-time"
},
"deleted": {
"description": "Indicates whether the object is deleted",
"type": "boolean"
},
"permDeleted": {
"description": "Indicates whether the object is permanently deleted",
"type": "boolean"
},
"expire": {
"description": "Date and time when the object expires and becomes inaccessible",
"type": "string",
"format": "date-time"
},
"modified": {
"description": "Date and time when the object was last modified",
"type": "string",
"format": "date-time"
},
"name": {
"description": "Display name of the object",
"type": "string"
},
"parentId": {
"description": "Parent Folder identifier",
"type": "string"
},
"userId": {
"description": "Unique identifier of Object creator",
"type": "string"
},
"parent": {
"description": "Folder that directly contains this object (Explicit field. May be retrieved only if mentioned in \"with\" parameter)",
"$ref": "#/components/schemas/Folder"
},
"permalink": {
"description": "Permanent URL for accessing the object in the web application",
"type": "string"
},
"creator": {
"description": "Basic profile information of the user who created the object (Explicit field. May be retrieved only if mentioned in \"with\" parameter)",
"$ref": "#/components/schemas/UserBasicInfo"
},
"permissions": {
"description": "Current user's permissions (Explicit field. May be retrieved only if mentioned in \"with\" parameter)",
"type": "array",
"items": {
"$ref": "#/components/schemas/Permission"
}
},
"vendorDocId": {
"description": "Identifier of the corresponding document in the external vendor system (Explicit field. May be retrieved only if mentioned in \"with\" parameter)",
"type": "string"
},
"vendorDocName": {
"description": "Display name of the corresponding document in the external vendor system (Explicit field. May be retrieved only if mentioned in \"with\" parameter)",
"type": "string"
},
"source": {
"description": "Numeric code identifying the external system that originated this object (e.g. Salesforce, Teams)",
"type": "integer"
},
"links": {
"description": "HATEOAS links associated with the entity",
"type": "array",
"items": {
"type": "string"
}
},
"mime": {
"description": "File MIME type",
"type": "string"
},
"size": {
"description": "Size of the file content in bytes",
"type": "string"
},
"fingerprint": {
"description": "Cryptographic fingerprint (hash) of the file content used for integrity verification",
"type": "string"
},
"tracking_id": {
"description": "File tracking ID (UUID)",
"type": "string"
},
"type": {
"type": "string"
},
"locked": {
"description": "Unique identifier of User who locked a File",
"type": "integer"
},
"lockUser": {
"description": "User who locked the File (Explicit field. May be retrieved only if mentioned in \"with\" parameter)",
"$ref": "#/components/schemas/User"
},
"clientCreated": {
"description": "Original created time of the file",
"type": "string",
"format": "date"
},
"clientModified": {
"description": "Original modified time of the file",
"type": "string",
"format": "date"
},
"members": {
"description": "File members list (Explicit field. May be retrieved only if mentioned in \"with\" parameter)",
"type": "array",
"items": {
"$ref": "#/components/schemas/Member"
}
},
"overriddenExpire": {
"description": "Indicates whether the file expiration date is overridden",
"type": "boolean"
},
"originalFileId": {
"description": "File identifier from which this file was copied from",
"type": "string"
},
"pushedObject": {
"description": "Contains pushedObject data if current file was ever pushed (Explicit field. May be retrieved only if mentioned in \"with\" parameter)",
"$ref": "#/components/schemas/PushedObject"
},
"avStatus": {
"description": "Check file availability status according to AV settings and file scanned/infected status",
"type": "string"
},
"dlpStatus": {
"description": "Check file availability status according to DLP settings and file scanned/infected status",
"type": "string"
},
"adminQuarantineStatus": {
"description": "Check file availability status according to admin quarantined status",
"type": "string"
},
"storageAvailable": {
"description": "Boolean value that shows if this file is available on any volume",
"type": "boolean"
},
"lastModifiedBy": {
"description": "Creator of the latest version (Explicit field. May be retrieved only if mentioned in \"with\" parameter)",
"$ref": "#/components/schemas/User"
},
"wopiapp": {
"description": "WOPI info for iOS app",
"type": "boolean"
},
"roleId": {
"description": "Highest role of the current user on this file",
"type": "string"
},
"isShared": {
"description": "Indicates whether the file is shared",
"type": "string"
},
"fingerprints": {
"description": "Array of file fingerprint objects",
"type": "array",
"items": {
"type": "string"
}
},
"tags": {
"description": "Array of tag objects",
"type": "array",
"items": {
"$ref": "#/components/schemas/Tag"
}
}
}
},
"EmailFormFile.Post": {
"description": "Class EmailFormFile",
"required": [
"name"
],
"properties": {
"addLinks": {
"description": "Indicates whether HATEOAS links should be included in the response",
"type": "boolean"
},
"name": {
"description": "Display name of the file",
"type": "string"
}
}
},
"EmailFormFile.Put": {
"description": "Class EmailFormFile",
"required": [
"name"
],
"properties": {
"addLinks": {
"description": "Indicates whether HATEOAS links should be included in the response",
"type": "boolean"
},
"name": {
"description": "Display name of the file",
"type": "string"
},
"expire": {
"description": "The file expiration date.",
"type": "string"
},
"replace": {
"description": "Replace the file if file with same name exists",
"type": "string"
}
}
},
"ConnectorOAuthLink": {
"description": "Class ConnectorOAuthLink",
"properties": {
"expire": {
"description": "Date and time after which the shortlink becomes invalid and can no longer be used",
"type": "string",
"format": "date"
},
"entityTypeId": {
"description": "Unique identifier of the entity type this shortlink is associated with",
"type": "integer"
},
"entityId": {
"description": "Unique identifier of the entity this shortlink points to, returned as a GUID from version 19 onwards",
"type": "string"
},
"entityTypeName": {
"description": "Human-readable name of the entity type this shortlink is associated with",
"type": "string"
},
"links": {
"description": "HATEOAS links associated with the entity",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"ConnectorOAuthLink.Post": {
"description": "Class ConnectorOAuthLink",
"properties": {
"ref": {
"description": "Shortlink handle. Example: abcdefg12",
"type": "string"
},
"expire": {
"description": "Date and time after which the shortlink becomes invalid and can no longer be used",
"type": "string",
"format": "date"
},
"entityTypeId": {
"description": "Unique identifier of entity type.\n * 1 = object,\n * 2 = email_package,\n * 3 = verification_code,\n * 4 = email_preview_package,\n * 5 = file_request,\n * 6 = add_file\n * 7 = password_reset,\n * 8 = gdrive_oauth,\n * 9 = connector_oauth,\n * 10 = comment,\n * 11 = task,\n * 12 = mobile_sync,\n * 13 = password_set,\n * 14 = event,\n * 15 = mail,\n * 16 = approval_request",
"type": "integer"
},
"entityId": {
"description": "Unique identifier of the entity this shortlink points to",
"type": "integer"
},
"length": {
"description": "Number of characters in the generated shortlink handle",
"type": "integer"
},
"addLinks": {
"description": "Indicates whether HATEOAS links should be included in the response",
"type": "boolean"
}
}
},
"ConnectorOAuthLink.Put": {
"description": "Class ConnectorOAuthLink",
"properties": {
"ref": {
"description": "Shortlink handle. Example: abcdefg12",
"type": "string"
},
"expire": {
"description": "Date and time after which the shortlink becomes invalid and can no longer be used",
"type": "string",
"format": "date"
},
"entityTypeId": {
"description": "Unique identifier of entity type.\n * 1 = object,\n * 2 = email_package,\n * 3 = verification_code,\n * 4 = email_preview_package,\n * 5 = file_request,\n * 6 = add_file\n * 7 = password_reset,\n * 8 = gdrive_oauth,\n * 9 = connector_oauth,\n * 10 = comment,\n * 11 = task,\n * 12 = mobile_sync,\n * 13 = password_set,\n * 14 = event,\n * 15 = mail,\n * 16 = approval_request",
"type": "integer"
},
"entityId": {
"description": "Unique identifier of the entity this shortlink points to",
"type": "integer"
},
"length": {
"description": "Number of characters in the generated shortlink handle",
"type": "integer"
},
"addLinks": {
"description": "Indicates whether HATEOAS links should be included in the response",
"type": "boolean"
}
}
},
"CommentLink": {
"description": "Class CommentLink",
"properties": {
"expire": {
"description": "Date and time after which the shortlink becomes invalid and can no longer be used",
"type": "string",
"format": "date"
},
"entityTypeId": {
"description": "Unique identifier of the entity type this shortlink is associated with",
"type": "integer"
},
"entityId": {
"description": "Unique identifier of the entity this shortlink points to, returned as a GUID from version 19 onwards",
"type": "string"
},
"entityTypeName": {
"description": "Human-readable name of the entity type this shortlink is associated with",
"type": "string"
},
"links": {
"description": "HATEOAS links associated with the entity",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"CommentLink.Post": {
"description": "Class CommentLink",
"properties": {
"ref": {
"description": "Shortlink handle. Example: abcdefg12",
"type": "string"
},
"expire": {
"description": "Date and time after which the shortlink becomes invalid and can no longer be used",
"type": "string",
"format": "date"
},
"entityTypeId": {
"description": "Unique identifier of entity type.\n * 1 = object,\n * 2 = email_package,\n * 3 = verification_code,\n * 4 = email_preview_package,\n * 5 = file_request,\n * 6 = add_file\n * 7 = password_reset,\n * 8 = gdrive_oauth,\n * 9 = connector_oauth,\n * 10 = comment,\n * 11 = task,\n * 12 = mobile_sync,\n * 13 = password_set,\n * 14 = event,\n * 15 = mail,\n * 16 = approval_request",
"type": "integer"
},
"entityId": {
"description": "Unique identifier of the entity this shortlink points to",
"type": "integer"
},
"length": {
"description": "Number of characters in the generated shortlink handle",
"type": "integer"
},
"addLinks": {
"description": "Indicates whether HATEOAS links should be included in the response",
"type": "boolean"
}
}
},
"CommentLink.Put": {
"description": "Class CommentLink",
"properties": {
"ref": {
"description": "Shortlink handle. Example: abcdefg12",
"type": "string"
},
"expire": {
"description": "Date and time after which the shortlink becomes invalid and can no longer be used",
"type": "string",
"format": "date"
},
"entityTypeId": {
"description": "Unique identifier of entity type.\n * 1 = object,\n * 2 = email_package,\n * 3 = verification_code,\n * 4 = email_preview_package,\n * 5 = file_request,\n * 6 = add_file\n * 7 = password_reset,\n * 8 = gdrive_oauth,\n * 9 = connector_oauth,\n * 10 = comment,\n * 11 = task,\n * 12 = mobile_sync,\n * 13 = password_set,\n * 14 = event,\n * 15 = mail,\n * 16 = approval_request",
"type": "integer"
},
"entityId": {
"description": "Unique identifier of the entity this shortlink points to",
"type": "integer"
},
"length": {
"description": "Number of characters in the generated shortlink handle",
"type": "integer"
},
"addLinks": {
"description": "Indicates whether HATEOAS links should be included in the response",
"type": "boolean"
}
}
},
"Version": {
"description": "Class Version",
"required": [
"id",
"name",
"objectId",
"userId",
"versionNumber"
],
"properties": {
"id": {
"description": "The unique identifier of the file version.",
"type": "string"
},
"versionNumber": {
"description": "The version number of the file.",
"type": "integer"
},
"deleted": {
"description": "Indicates whether this version of the file has been deleted.",
"type": "boolean"
},
"created": {
"description": "The creation date of this file version.",
"type": "string",
"format": "date"
},
"userId": {
"description": "The unique identifier of the user who created this file version.",
"type": "string"
},
"size": {
"description": "The size of the file content in bytes.",
"type": "integer"
},
"fingerprint": {
"description": "A unique hash identifying the file.",
"type": "string"
},
"fingerprintAlgo": {
"description": "The algorithm used to generate the fingerprint (e.g., sha3-256, md5).",
"type": "string"
},
"backend": {
"description": "The backend system associated with the file version.",
"type": "string"
},
"mime": {
"description": "The MIME type of the file version.",
"type": "string"
},
"name": {
"description": "The name of the file version.",
"type": "string"
},
"creator": {
"description": "The user who created the file version. (Explicit field. May be retrieved only if mentioned in \"with\" parameter)",
"$ref": "#/components/schemas/UserBasicInfo"
},
"objectId": {
"description": "The object ID (UUID) for the file version.",
"type": "string"
},
"clientCreated": {
"description": "The date and time the file version was created on the client side.",
"type": "string",
"format": "date"
},
"clientModified": {
"description": "The date and time the file version was last modified on the client side.",
"type": "string",
"format": "date"
},
"avStatus": {
"description": "Indicates the file version's availability status based on Antivirus (AV) settings and whether it has been scanned or detected as infected.",
"type": "string"
},
"dlpStatus": {
"description": "Indicates the file version's availability status based on Data Loss Prevention (DLP) settings and whether it has been scanned or detected as infected.",
"type": "string"
},
"adminQuarantineStatus": {
"description": "Indicates the file version\\'s availability status based on the administrator\\'s quarantine status. ",
"type": "string"
},
"storageAvailable": {
"description": "Indicates whether the file is accessible on any storage volume.",
"type": "boolean"
},
"fingerprints": {
"description": "A list of fingerprints associated with the file version.",
"type": "array",
"items": {
"type": "string"
}
},
"tags": {
"description": "List of tags associated with the file.",
"type": "array",
"items": {
"$ref": "#/components/schemas/Tag"
}
},
"links": {
"description": "HATEOAS links associated with the entity",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"Version.Post": {
"description": "Class Version",
"required": [
"name"
],
"properties": {
"versionNumber": {
"description": "The version number of the file.",
"type": "integer"
},
"deleted": {
"description": "Indicates whether the version has been deleted.",
"type": "boolean"
},
"fingerprint": {
"description": "The fingerprint hash that uniquely identifies the file content",
"type": "string"
},
"clientCreated": {
"description": "The date and time the file version was created on the client side.",
"type": "integer"
},
"clientModified": {
"description": "The date and time the file version was last modified on the client side.",
"type": "integer"
},
"status": {
"description": "The current status of the file version.",
"type": "string"
},
"size": {
"description": "The size of the file version in bytes.",
"type": "integer"
},
"user": {
"description": "The user who created the file version.",
"$ref": "#/components/schemas/User"
},
"name": {
"description": "The name of the file version.",
"type": "string"
},
"id": {
"description": "The unique identifier for the file version.",
"type": "integer"
},
"flag": {
"description": "Bitwise flag to indicate whether the version has been quarantined. Possible numeric values are: 2: quarantined, 0: not quarantined ",
"type": "integer"
},
"archived": {
"description": "Indicates whether this version has been archived",
"type": "integer"
},
"objectId": {
"description": "The object ID (UUID) for the file version.",
"type": "integer"
},
"location": {
"description": "The file location of this version",
"type": "integer"
},
"created": {
"description": "The date and time the file version was created.",
"type": "string",
"format": "date"
},
"mime": {
"description": "The MIME type of the file version.",
"type": "string"
},
"backend": {
"description": "The backend system associated with the file version.",
"type": "string"
},
"file": {
"description": "The file entity associated with this version.",
"$ref": "#/components/schemas/File"
},
"addLinks": {
"description": "Indicates whether HATEOAS links should be included in the response",
"type": "boolean"
}
}
},
"Version.Put": {
"description": "Class Version",
"required": [
"name"
],
"properties": {
"versionNumber": {
"description": "The version number of the file.",
"type": "integer"
},
"deleted": {
"description": "Indicates whether the version has been deleted.",
"type": "boolean"
},
"fingerprint": {
"description": "The fingerprint hash that uniquely identifies the file content",
"type": "string"
},
"clientCreated": {
"description": "The date and time the file version was created on the client side.",
"type": "integer"
},
"clientModified": {
"description": "The date and time the file version was last modified on the client side.",
"type": "integer"
},
"status": {
"description": "The current status of the file version.",
"type": "string"
},
"size": {
"description": "The size of the file version in bytes.",
"type": "integer"
},
"user": {
"description": "The user who created the file version.",
"$ref": "#/components/schemas/User"
},
"name": {
"description": "The name of the file version.",
"type": "string"
},
"id": {
"description": "The unique identifier for the file version.",
"type": "integer"
},
"flag": {
"description": "Bitwise flag to indicate whether the version has been quarantined. Possible numeric values are: 2: quarantined, 0: not quarantined ",
"type": "integer"
},
"archived": {
"description": "Indicates whether this version has been archived",
"type": "integer"
},
"objectId": {
"description": "The object ID (UUID) for the file version.",
"type": "integer"
},
"location": {
"description": "The file location of this version",
"type": "integer"
},
"created": {
"description": "The date and time the file version was created.",
"type": "string",
"format": "date"
},
"mime": {
"description": "The MIME type of the file version.",
"type": "string"
},
"backend": {
"description": "The backend system associated with the file version.",
"type": "string"
},
"file": {
"description": "The file entity associated with this version.",
"$ref": "#/components/schemas/File"
},
"addLinks": {
"description": "Indicates whether HATEOAS links should be included in the response",
"type": "boolean"
}
}
},
"AdminRole": {
"description": "Class AdminRole",
"required": [
"id",
"name"
],
"properties": {
"id": {
"description": "Admin role unique identifier",
"type": "integer"
},
"name": {
"description": "Display name of the admin role",
"type": "string"
},
"guid": {
"description": "Admin role globally unique identifier",
"type": "string"
},
"links": {
"description": "HATEOAS links associated with the entity",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"AdminRole.Post": {
"description": "Class AdminRole",
"required": [
"name"
],
"properties": {
"name": {
"description": "Display name of the admin role",
"type": "string"
},
"addLinks": {
"description": "Indicates whether HATEOAS links should be included in the response",
"type": "boolean"
}
}
},
"AdminRole.Put": {
"description": "Class AdminRole",
"required": [
"name"
],
"properties": {
"name": {
"description": "Display name of the admin role",
"type": "string"
},
"addLinks": {
"description": "Indicates whether HATEOAS links should be included in the response",
"type": "boolean"
}
}
},
"SourceFile": {
"required": [
"id",
"name",
"parentId",
"type",
"wopiapp"
],
"properties": {
"id": {
"description": "Unique SourceContent identifier",
"type": "string"
},
"name": {
"description": "Display name of the source content item",
"type": "string"
},
"parentId": {
"description": "Parent source content unique identifier",
"type": "string"
},
"type": {
"description": "Source content type. Accepted values: \\`d\\` (folder), \\`f\\` (file)",
"type": "string"
},
"created": {
"description": "Creation timestamp of the source content in UTC",
"type": "string",
"format": "date"
},
"modified": {
"description": "Last modification timestamp of the source content in UTC",
"type": "string",
"format": "date"
},
"status": {
"description": "Current availability status of the source content item",
"type": "string"
},
"deleted": {
"description": "Indicates whether the source content is deleted",
"type": "boolean"
},
"path": {
"description": "Full path of the source content",
"type": "string"
},
"userRoleId": {
"description": "Current user role id (Explicit field. May be retrieved only if mentioned in \"with\" parameter)",
"type": "integer"
},
"creator": {
"description": "File's creator (Explicit field. May be retrieved only if mentioned in \"with\" parameter)",
"$ref": "#/components/schemas/UserBasicInfo"
},
"permissions": {
"description": "Current user's permissions (Explicit field. May be retrieved only if mentioned in \"with\" parameter)",
"type": "array",
"items": {
"$ref": "#/components/schemas/Permission"
}
},
"wopiapp": {
"description": "WOPI info for iOS app",
"type": "boolean"
},
"rootId": {
"description": "Unique identifier of the root-level source content ancestor (Explicit field. May be retrieved only if mentioned in \"with\" parameter)",
"type": "string"
},
"pathIds": {
"description": "Ordered list of ancestor identifiers representing the full path from root to this source content item (Explicit field. May be retrieved only if mentioned in \"with\" parameter)",
"type": "string"
},
"sourceTypeId": {
"description": "Unique identifier of the ECM source type this content belongs to (Explicit field. May be retrieved only if mentioned in \"with\" parameter)",
"type": "string"
},
"totalFilesCount": {
"description": "Total number of files in the source content (Explicit field. May be retrieved only if mentioned in \"with\" parameter)",
"type": "string"
},
"totalFoldersCount": {
"description": "Total number of folders in the source content (Explicit field. May be retrieved only if mentioned in \"with\" parameter)",
"type": "string"
},
"parent": {
"description": "Parent source content item (Explicit field. May be retrieved only if mentioned in \"with\" parameter)",
"$ref": "#/components/schemas/SourceContent"
},
"links": {
"description": "HATEOAS links associated with the entity",
"type": "array",
"items": {
"type": "string"
}
},
"locked": {
"description": "Indicates whether the file is locked",
"type": "boolean"
},
"size": {
"description": "Size of the source file in bytes",
"type": "integer"
},
"fingerprint": {
"description": "File content fingerprint",
"type": "string"
},
"expire": {
"description": "Date and time after which the source file expires and becomes unavailable",
"type": "string"
},
"mime": {
"description": "File MIME type",
"type": "string"
},
"avStatus": {
"description": "Check file availability status according to AV settings and file scanned/infected status",
"type": "string"
},
"dlpStatus": {
"description": "Check file availability status according to DLP settings and file scanned/infected status",
"type": "string"
},
"lockedUserName": {
"description": "Username/email of user who locked the file",
"type": "string"
},
"lockUser": {
"description": "User who locked the file",
"$ref": "#/components/schemas/UserBasicInfo"
}
}
},
"SourceFile.Post": {
"properties": {
"id": {
"description": "Unique SourceContent identifier",
"type": "string"
},
"addLinks": {
"description": "Indicates whether HATEOAS links should be included in the response",
"type": "boolean"
}
}
},
"SourceFile.Put": {
"properties": {
"id": {
"description": "Unique SourceContent identifier",
"type": "string"
},
"addLinks": {
"description": "Indicates whether HATEOAS links should be included in the response",
"type": "boolean"
}
}
},
"Member": {
"type": "object",
"properties": {
"objectId": {
"type": "string",
"description": "Unique identifier (UUID) of the associated object (file or folder)."
},
"roleId": {
"type": "integer",
"description": "Role assigned to the member."
},
"userId": {
"type": "string",
"description": "Unique identifier (UUID) of the user."
},
"groupId": {
"type": "integer",
"description": "Unique identifier of the LDAP group."
},
"user": {
"description": "User details of the member.",
"allOf": [
{
"$ref": "#/components/schemas/UserBasic"
}
]
},
"role": {
"description": "Role details assigned to the member.",
"allOf": [
{
"$ref": "#/components/schemas/Role"
}
]
},
"group": {
"description": "Group details if the member belongs to a group.",
"allOf": [
{
"$ref": "#/components/schemas/Group"
}
]
},
"sharedBy": {
"description": "Details of the user who shared the file or folder.",
"allOf": [
{
"$ref": "#/components/schemas/UserBasic"
}
]
},
"created": {
"type": "string",
"format": "date",
"description": "Date when the file or folder was shared."
},
"inheritRoleId": {
"type": "integer",
"description": "Inherited role ID from the parent folder, if applicable."
},
"allowedFolderRoleId": {
"type": "array",
"description": "List of allowed folder role IDs.",
"items": {
"type": "integer"
}
},
"email": {
"type": "string",
"description": "Email associated with the member."
},
"rank": {
"type": "integer",
"description": "Rank of the member role."
},
"originFolder": {
"readOnly": true
}
}
},
"Member.Post": {
"description": "Class Member",
"required": [
"roleId"
],
"properties": {
"roleId": {
"description": "Unique identifier of the role to assign to this member",
"type": "integer"
},
"addLinks": {
"description": "Indicates whether HATEOAS links should be included in the response",
"type": "boolean"
},
"userId": {
"description": "User's unique identifier",
"type": "integer"
},
"email": {
"description": "User email address",
"type": "string"
},
"notify": {
"description": "Indicates whether user would like to receive emails when new member is added into folder",
"type": "boolean",
"default": true
}
}
},
"Member.Put": {
"description": "Class Member",
"required": [
"roleId"
],
"properties": {
"roleId": {
"description": "Unique identifier of the role to assign to this member",
"type": "integer"
},
"notifyFileAdded": {
"description": "Indicates whether the member should be notified when a file is added",
"type": "boolean"
},
"addLinks": {
"description": "Indicates whether HATEOAS links should be included in the response",
"type": "boolean"
},
"notify": {
"description": "Indicates whether user would like to receive emails when new member is added into folder",
"type": "boolean",
"default": true
}
}
},
"ECObject": {
"description": "Class ECObject",
"required": [
"id",
"parentId",
"path",
"sourceId"
],
"properties": {
"id": {
"description": "Repositories Gateway Object unique identifier",
"type": "integer"
},
"parentId": {
"description": "Unique identifier of the parent Repositories Gateway Object",
"type": "integer"
},
"sourceId": {
"description": "Repositories Gateway Source unique identifier",
"type": "integer"
},
"path": {
"description": "Full path to the object within the Repositories Gateway source",
"type": "string"
},
"ecSource": {
"description": "Repositories Gateway Source (Explicit field. May be retrieved only if mentioned in \"with\" parameter)",
"type": "string"
},
"sourceTypeId": {
"description": "Unique identifier of the Repositories Gateway Source type",
"type": "integer"
}
}
},
"EventLink": {
"description": "Class EventLink",
"properties": {
"expire": {
"description": "Date and time after which the shortlink becomes invalid and can no longer be used",
"type": "string",
"format": "date"
},
"entityTypeId": {
"description": "Unique identifier of the entity type this shortlink is associated with",
"type": "integer"
},
"entityId": {
"description": "Unique identifier of the entity this shortlink points to, returned as a GUID from version 19 onwards",
"type": "string"
},
"entityTypeName": {
"description": "Human-readable name of the entity type this shortlink is associated with",
"type": "string"
},
"links": {
"description": "HATEOAS links associated with the entity",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"EventLink.Post": {
"description": "Class EventLink",
"properties": {
"ref": {
"description": "Shortlink handle. Example: abcdefg12",
"type": "string"
},
"expire": {
"description": "Date and time after which the shortlink becomes invalid and can no longer be used",
"type": "string",
"format": "date"
},
"entityTypeId": {
"description": "Unique identifier of entity type.\n * 1 = object,\n * 2 = email_package,\n * 3 = verification_code,\n * 4 = email_preview_package,\n * 5 = file_request,\n * 6 = add_file\n * 7 = password_reset,\n * 8 = gdrive_oauth,\n * 9 = connector_oauth,\n * 10 = comment,\n * 11 = task,\n * 12 = mobile_sync,\n * 13 = password_set,\n * 14 = event,\n * 15 = mail,\n * 16 = approval_request",
"type": "integer"
},
"entityId": {
"description": "Unique identifier of the entity this shortlink points to",
"type": "integer"
},
"length": {
"description": "Number of characters in the generated shortlink handle",
"type": "integer"
},
"addLinks": {
"description": "Indicates whether HATEOAS links should be included in the response",
"type": "boolean"
}
}
},
"EventLink.Put": {
"description": "Class EventLink",
"properties": {
"ref": {
"description": "Shortlink handle. Example: abcdefg12",
"type": "string"
},
"expire": {
"description": "Date and time after which the shortlink becomes invalid and can no longer be used",
"type": "string",
"format": "date"
},
"entityTypeId": {
"description": "Unique identifier of entity type.\n * 1 = object,\n * 2 = email_package,\n * 3 = verification_code,\n * 4 = email_preview_package,\n * 5 = file_request,\n * 6 = add_file\n * 7 = password_reset,\n * 8 = gdrive_oauth,\n * 9 = connector_oauth,\n * 10 = comment,\n * 11 = task,\n * 12 = mobile_sync,\n * 13 = password_set,\n * 14 = event,\n * 15 = mail,\n * 16 = approval_request",
"type": "integer"
},
"entityId": {
"description": "Unique identifier of the entity this shortlink points to",
"type": "integer"
},
"length": {
"description": "Number of characters in the generated shortlink handle",
"type": "integer"
},
"addLinks": {
"description": "Indicates whether HATEOAS links should be included in the response",
"type": "boolean"
}
}
},
"PasswordSetLink": {
"description": "Class ObjectLink",
"properties": {
"expire": {
"description": "Date and time after which the shortlink becomes invalid and can no longer be used",
"type": "string",
"format": "date"
},
"entityTypeId": {
"description": "Unique identifier of the entity type this shortlink is associated with",
"type": "integer"
},
"entityId": {
"description": "Unique identifier of the entity this shortlink points to, returned as a GUID from version 19 onwards",
"type": "string"
},
"entityTypeName": {
"description": "Human-readable name of the entity type this shortlink is associated with",
"type": "string"
},
"links": {
"description": "HATEOAS links associated with the entity",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"PasswordSetLink.Post": {
"description": "Class ObjectLink",
"properties": {
"ref": {
"description": "Shortlink handle. Example: abcdefg12",
"type": "string"
},
"expire": {
"description": "Date and time after which the shortlink becomes invalid and can no longer be used",
"type": "string",
"format": "date"
},
"entityTypeId": {
"description": "Unique identifier of entity type.\n * 1 = object,\n * 2 = email_package,\n * 3 = verification_code,\n * 4 = email_preview_package,\n * 5 = file_request,\n * 6 = add_file\n * 7 = password_reset,\n * 8 = gdrive_oauth,\n * 9 = connector_oauth,\n * 10 = comment,\n * 11 = task,\n * 12 = mobile_sync,\n * 13 = password_set,\n * 14 = event,\n * 15 = mail,\n * 16 = approval_request",
"type": "integer"
},
"entityId": {
"description": "Unique identifier of the entity this shortlink points to",
"type": "integer"
},
"length": {
"description": "Number of characters in the generated shortlink handle",
"type": "integer"
},
"addLinks": {
"description": "Indicates whether HATEOAS links should be included in the response",
"type": "boolean"
}
}
},
"PasswordSetLink.Put": {
"description": "Class ObjectLink",
"properties": {
"ref": {
"description": "Shortlink handle. Example: abcdefg12",
"type": "string"
},
"expire": {
"description": "Date and time after which the shortlink becomes invalid and can no longer be used",
"type": "string",
"format": "date"
},
"entityTypeId": {
"description": "Unique identifier of entity type.\n * 1 = object,\n * 2 = email_package,\n * 3 = verification_code,\n * 4 = email_preview_package,\n * 5 = file_request,\n * 6 = add_file\n * 7 = password_reset,\n * 8 = gdrive_oauth,\n * 9 = connector_oauth,\n * 10 = comment,\n * 11 = task,\n * 12 = mobile_sync,\n * 13 = password_set,\n * 14 = event,\n * 15 = mail,\n * 16 = approval_request",
"type": "integer"
},
"entityId": {
"description": "Unique identifier of the entity this shortlink points to",
"type": "integer"
},
"length": {
"description": "Number of characters in the generated shortlink handle",
"type": "integer"
},
"addLinks": {
"description": "Indicates whether HATEOAS links should be included in the response",
"type": "boolean"
}
}
},
"Package": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"description": "Unique identifier of the email package."
},
"selfCopy": {
"type": "boolean",
"description": "Indicates whether the package includes a copy for the sender."
},
"includeFingerprint": {
"type": "boolean",
"description": "Indicates whether a fingerprint (hash) of the package should be included for verification."
},
"expire": {
"type": "integer",
"description": "Expiration time of the package in seconds from creation."
},
"fileCount": {
"readOnly": true,
"description": "Count of the files attached to the package."
},
"deleted": {
"type": "boolean",
"description": "Indicates whether the package has been marked as deleted."
},
"acl": {
"type": "string",
"description": "Access control list (ACL) associated with the package, specifying who can access it."
},
"attachments": {
"description": "List of attachments included in the package.",
"type": "array",
"items": {
"$ref": "#/components/schemas/Attachment"
}
},
"downloadLink": {
"type": "string",
"description": "Link for accessing the email."
}
}
},
"Package.Post": {
"description": "Class Package",
"properties": {
"selfCopy": {
"description": "Indicates whether a copy of the email is sent to the sender",
"type": "boolean"
},
"includeFingerprint": {
"description": "Indicates whether file fingerprints are included in the email",
"type": "boolean"
},
"expire": {
"description": "Number of hours after which the email package expires",
"type": "string",
"format": "date-time"
},
"fileCount": {
"description": "Number of files included in the email package",
"type": "integer"
},
"deleted": {
"description": "Indicates whether the email package has been deleted",
"type": "boolean"
},
"acl": {
"description": "Access control level for the email package. Accepted values: `verify_recipient`, `no_auth`, `otp`, `internal`, `anyone_auth`, `email_otp`",
"type": "string",
"enum": [
"verify_recipient",
"no_auth",
"otp",
"internal",
"anyone_auth",
"email_otp"
]
},
"addLinks": {
"description": "Indicates whether HATEOAS links should be included in the response",
"type": "boolean"
}
}
},
"Package.Put": {
"description": "Class Package",
"properties": {
"selfCopy": {
"description": "Indicates whether a copy of the email is sent to the sender",
"type": "boolean"
},
"includeFingerprint": {
"description": "Indicates whether file fingerprints are included in the email",
"type": "boolean"
},
"expire": {
"description": "Number of hours after which the email package expires",
"type": "string",
"format": "date-time"
},
"fileCount": {
"description": "Number of files included in the email package",
"type": "integer"
},
"deleted": {
"description": "Indicates whether the email package has been deleted",
"type": "boolean"
},
"acl": {
"description": "Access control level for the email package. Accepted values: `verify_recipient`, `no_auth`, `otp`, `internal`, `anyone_auth`, `email_otp`",
"type": "string",
"enum": [
"verify_recipient",
"no_auth",
"otp",
"internal",
"anyone_auth",
"email_otp"
]
},
"addLinks": {
"description": "Indicates whether HATEOAS links should be included in the response",
"type": "boolean"
}
}
},
"PasswordResetLink": {
"description": "Class RequestFileLink",
"properties": {
"expire": {
"description": "Date and time after which the shortlink becomes invalid and can no longer be used",
"type": "string",
"format": "date"
},
"entityTypeId": {
"description": "Unique identifier of the entity type this shortlink is associated with",
"type": "integer"
},
"entityId": {
"description": "Unique identifier of the entity this shortlink points to, returned as a GUID from version 19 onwards",
"type": "string"
},
"entityTypeName": {
"description": "Human-readable name of the entity type this shortlink is associated with",
"type": "string"
},
"links": {
"description": "HATEOAS links associated with the entity",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"PasswordResetLink.Post": {
"description": "Class RequestFileLink",
"properties": {
"ref": {
"description": "Shortlink handle. Example: abcdefg12",
"type": "string"
},
"expire": {
"description": "Date and time after which the shortlink becomes invalid and can no longer be used",
"type": "string",
"format": "date"
},
"entityTypeId": {
"description": "Unique identifier of entity type.\n * 1 = object,\n * 2 = email_package,\n * 3 = verification_code,\n * 4 = email_preview_package,\n * 5 = file_request,\n * 6 = add_file\n * 7 = password_reset,\n * 8 = gdrive_oauth,\n * 9 = connector_oauth,\n * 10 = comment,\n * 11 = task,\n * 12 = mobile_sync,\n * 13 = password_set,\n * 14 = event,\n * 15 = mail,\n * 16 = approval_request",
"type": "integer"
},
"entityId": {
"description": "Unique identifier of the entity this shortlink points to",
"type": "integer"
},
"length": {
"description": "Number of characters in the generated shortlink handle",
"type": "integer"
},
"addLinks": {
"description": "Indicates whether HATEOAS links should be included in the response",
"type": "boolean"
}
}
},
"PasswordResetLink.Put": {
"description": "Class RequestFileLink",
"properties": {
"ref": {
"description": "Shortlink handle. Example: abcdefg12",
"type": "string"
},
"expire": {
"description": "Date and time after which the shortlink becomes invalid and can no longer be used",
"type": "string",
"format": "date"
},
"entityTypeId": {
"description": "Unique identifier of entity type.\n * 1 = object,\n * 2 = email_package,\n * 3 = verification_code,\n * 4 = email_preview_package,\n * 5 = file_request,\n * 6 = add_file\n * 7 = password_reset,\n * 8 = gdrive_oauth,\n * 9 = connector_oauth,\n * 10 = comment,\n * 11 = task,\n * 12 = mobile_sync,\n * 13 = password_set,\n * 14 = event,\n * 15 = mail,\n * 16 = approval_request",
"type": "integer"
},
"entityId": {
"description": "Unique identifier of the entity this shortlink points to",
"type": "integer"
},
"length": {
"description": "Number of characters in the generated shortlink handle",
"type": "integer"
},
"addLinks": {
"description": "Indicates whether HATEOAS links should be included in the response",
"type": "boolean"
}
}
},
"TaskLink": {
"description": "Class TaskLink",
"properties": {
"expire": {
"description": "Date and time after which the shortlink becomes invalid and can no longer be used",
"type": "string",
"format": "date"
},
"entityTypeId": {
"description": "Unique identifier of the entity type this shortlink is associated with",
"type": "integer"
},
"entityId": {
"description": "Unique identifier of the entity this shortlink points to, returned as a GUID from version 19 onwards",
"type": "string"
},
"entityTypeName": {
"description": "Human-readable name of the entity type this shortlink is associated with",
"type": "string"
},
"links": {
"description": "HATEOAS links associated with the entity",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"TaskLink.Post": {
"description": "Class TaskLink",
"properties": {
"ref": {
"description": "Shortlink handle. Example: abcdefg12",
"type": "string"
},
"expire": {
"description": "Date and time after which the shortlink becomes invalid and can no longer be used",
"type": "string",
"format": "date"
},
"entityTypeId": {
"description": "Unique identifier of entity type.\n * 1 = object,\n * 2 = email_package,\n * 3 = verification_code,\n * 4 = email_preview_package,\n * 5 = file_request,\n * 6 = add_file\n * 7 = password_reset,\n * 8 = gdrive_oauth,\n * 9 = connector_oauth,\n * 10 = comment,\n * 11 = task,\n * 12 = mobile_sync,\n * 13 = password_set,\n * 14 = event,\n * 15 = mail,\n * 16 = approval_request",
"type": "integer"
},
"entityId": {
"description": "Unique identifier of the entity this shortlink points to",
"type": "integer"
},
"length": {
"description": "Number of characters in the generated shortlink handle",
"type": "integer"
},
"addLinks": {
"description": "Indicates whether HATEOAS links should be included in the response",
"type": "boolean"
}
}
},
"TaskLink.Put": {
"description": "Class TaskLink",
"properties": {
"ref": {
"description": "Shortlink handle. Example: abcdefg12",
"type": "string"
},
"expire": {
"description": "Date and time after which the shortlink becomes invalid and can no longer be used",
"type": "string",
"format": "date"
},
"entityTypeId": {
"description": "Unique identifier of entity type.\n * 1 = object,\n * 2 = email_package,\n * 3 = verification_code,\n * 4 = email_preview_package,\n * 5 = file_request,\n * 6 = add_file\n * 7 = password_reset,\n * 8 = gdrive_oauth,\n * 9 = connector_oauth,\n * 10 = comment,\n * 11 = task,\n * 12 = mobile_sync,\n * 13 = password_set,\n * 14 = event,\n * 15 = mail,\n * 16 = approval_request",
"type": "integer"
},
"entityId": {
"description": "Unique identifier of the entity this shortlink points to",
"type": "integer"
},
"length": {
"description": "Number of characters in the generated shortlink handle",
"type": "integer"
},
"addLinks": {
"description": "Indicates whether HATEOAS links should be included in the response",
"type": "boolean"
}
}
},
"DliFolder": {
"description": "Class DliFolder",
"required": [
"id",
"name",
"parentId",
"type",
"userId"
],
"properties": {
"id": {
"description": "Unique identifier of object",
"type": "string"
},
"created": {
"description": "Date and time when the object was created",
"type": "string",
"format": "date-time"
},
"deleted": {
"description": "Indicates whether the object is deleted",
"type": "boolean"
},
"permDeleted": {
"description": "Indicates whether the object is permanently deleted",
"type": "boolean"
},
"expire": {
"description": "Date and time when the object expires and becomes inaccessible",
"type": "string",
"format": "date-time"
},
"modified": {
"description": "Date and time when the object was last modified",
"type": "string",
"format": "date-time"
},
"name": {
"description": "Display name of the object",
"type": "string"
},
"parentId": {
"description": "Parent Folder identifier",
"type": "string"
},
"userId": {
"description": "Unique identifier of Object creator",
"type": "string"
},
"parent": {
"description": "Folder that directly contains this object (Explicit field. May be retrieved only if mentioned in \"with\" parameter)",
"$ref": "#/components/schemas/Folder"
},
"permalink": {
"description": "Permanent URL for accessing the object in the web application",
"type": "string"
},
"creator": {
"description": "Basic profile information of the user who created the object (Explicit field. May be retrieved only if mentioned in \"with\" parameter)",
"$ref": "#/components/schemas/UserBasicInfo"
},
"permissions": {
"description": "Current user's permissions (Explicit field. May be retrieved only if mentioned in \"with\" parameter)",
"type": "array",
"items": {
"$ref": "#/components/schemas/Permission"
}
},
"vendorDocId": {
"description": "Identifier of the corresponding document in the external vendor system (Explicit field. May be retrieved only if mentioned in \"with\" parameter)",
"type": "string"
},
"vendorDocName": {
"description": "Display name of the corresponding document in the external vendor system (Explicit field. May be retrieved only if mentioned in \"with\" parameter)",
"type": "string"
},
"source": {
"description": "Numeric code identifying the external system that originated this object (e.g. Salesforce, Teams)",
"type": "integer"
},
"links": {
"description": "HATEOAS links associated with the entity",
"type": "array",
"items": {
"type": "string"
}
},
"type": {
"type": "string"
},
"description": {
"description": "Optional text description of the folder's purpose or contents",
"type": "string"
},
"syncable": {
"description": "Indicates that folder is syncable. Can only be set at a top level folder.",
"type": "boolean"
},
"fileLifetime": {
"description": "The file's lifetime in the folder",
"type": "string"
},
"useFolderQuota": {
"description": "Indicates whether the folder is a system quota folder or belongs to one",
"type": "string"
},
"inheritanceEnabled": {
"description": "Indicates whether permission inheritance is enabled for this folder",
"type": "boolean"
},
"members": {
"description": "Folder members list (Explicit field. May be retrieved only if mentioned in \"with\" parameter)",
"type": "array",
"items": {
"$ref": "#/components/schemas/MemberBase"
}
},
"secure": {
"description": "Indicates that Folder is secure. Only top level folders under user's root folder can be set to secure",
"type": "boolean"
},
"isFavorite": {
"description": "Indicates that Folder is marked as favorite for current user (Explicit field. May be retrieved only if mentioned in \"with\" parameter)",
"type": "boolean"
},
"pushedFilesCount": {
"description": "Count of pushed files inside folder (Explicit field. May be retrieved only if mentioned in \"with\" parameter)",
"type": "integer"
},
"path": {
"description": "Shows folder full path up to folder on which current folder has permissions",
"type": "string"
},
"currentUserRole": {
"description": "Current user's permissions (Explicit field. May be retrieved only if mentioned in \"with\" parameter)",
"$ref": "#/components/schemas/Role"
},
"totalFilesCount": {
"description": "Count of files inside folder (Explicit field. May be retrieved only if mentioned in \"with\" parameter)",
"type": "integer"
},
"totalFoldersCount": {
"description": "Count of child folders (Explicit field. May be retrieved only if mentioned in \"with\" parameter)",
"type": "integer"
},
"totalMembersCount": {
"description": "Count of folder's members (Explicit field. May be retrieved only if mentioned in \"with\" parameter)",
"type": "integer"
},
"isShared": {
"description": "Indicates that Folder is shared to users/groups (Explicit field. May be retrieved only if mentioned in \"with\" parameter)",
"type": "boolean"
},
"avStatus": {
"description": "Check folder availability status according to AV settings and folder files scanned/infected status (Explicit field. May be retrieved only if mentioned in \"with\" parameter)",
"type": "string"
},
"dlpStatus": {
"description": "Check folder availability status according to DLP settings and folder files scanned/infected status (Explicit field. May be retrieved only if mentioned in \"with\" parameter)",
"type": "string"
},
"maxFolderExpiration": {
"description": "Get profile max folder expiration as a date",
"type": "string"
},
"maxFileLifetime": {
"description": "Get profile max file lifetime",
"type": "string"
}
}
},
"DliFolder.Post": {
"description": "Class DliFolder",
"required": [
"name"
],
"properties": {
"addLinks": {
"description": "Indicates whether HATEOAS links should be included in the response",
"type": "boolean"
},
"name": {
"description": "Display name of the folder",
"type": "string"
},
"description": {
"description": "Optional text description of the folder's purpose or contents",
"type": "string"
},
"syncable": {
"description": "Indicates that folder is syncable. Can only be set at a top level folder.",
"type": "boolean"
},
"expire": {
"description": "The folder expiration date. Applicable to top level folders",
"type": "string",
"format": "date"
},
"fileLifetime": {
"description": "The file's lifetime in the folder",
"type": "integer"
},
"inheritanceEnabled": {
"description": "Set to false to disable permission inheritance for this subfolder",
"type": "boolean"
},
"secure": {
"description": "Indicates whether folder is secure. Only top level folders under user's root folder can be set to secure",
"type": "boolean"
}
}
},
"DliFolder.Put": {
"description": "Class DliFolder",
"required": [
"name"
],
"properties": {
"addLinks": {
"description": "Indicates whether HATEOAS links should be included in the response",
"type": "boolean"
},
"name": {
"description": "Display name of the folder",
"type": "string"
},
"description": {
"description": "Optional text description of the folder's purpose or contents",
"type": "string"
},
"syncable": {
"description": "Indicates that folder is syncable. Can only be set at a top level folder.",
"type": "boolean"
},
"expire": {
"description": "The folder expiration date. Applicable to top level folders",
"type": "string",
"format": "date"
},
"fileLifetime": {
"description": "The file's lifetime in the folder",
"type": "integer"
},
"inheritanceEnabled": {
"description": "Set to false to disable permission inheritance for this subfolder",
"type": "boolean"
},
"applyFileLifetimeToFiles": {
"description": "Apply file lifetime setting to existing files",
"type": "boolean"
},
"applyFileLifetimeToNested": {
"description": "Apply file lifetime setting to nested folders",
"type": "boolean"
},
"secure": {
"description": "Indicates whether folder is secure. Only top level folders under user's root folder can be set to secure",
"type": "boolean"
}
}
},
"EmailEcItemJob": {
"properties": {
"id": {
"description": "Job unique identifier",
"type": "string"
},
"status": {
"description": "Current job status. Accepted values: `queued`, `working`, `succeeded`, `failed`",
"type": "string"
},
"errors": {
"description": "List of errors that occurred during job processing",
"type": "string"
},
"objectIds": {
"description": "List of object IDs associated with this job",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"RefreshToken": {
"description": "Class RefreshToken",
"required": [
"refreshToken",
"scope"
],
"properties": {
"userId": {
"description": "Unique identifier of the user to whom the refresh token belongs",
"type": "integer"
},
"expire": {
"description": "Date and time after which the refresh token is no longer valid",
"type": "string",
"format": "date-time"
},
"scope": {
"description": "OAuth scope of the refresh token",
"type": "string"
},
"refreshToken": {
"description": "Refresh token value",
"type": "string"
}
}
},
"GDriveOAuthLink": {
"description": "Class GDriveOAuthLink",
"properties": {
"expire": {
"description": "Date and time after which the shortlink becomes invalid and can no longer be used",
"type": "string",
"format": "date"
},
"entityTypeId": {
"description": "Unique identifier of the entity type this shortlink is associated with",
"type": "integer"
},
"entityId": {
"description": "Unique identifier of the entity this shortlink points to, returned as a GUID from version 19 onwards",
"type": "string"
},
"entityTypeName": {
"description": "Human-readable name of the entity type this shortlink is associated with",
"type": "string"
},
"links": {
"description": "HATEOAS links associated with the entity",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"GDriveOAuthLink.Post": {
"description": "Class GDriveOAuthLink",
"properties": {
"ref": {
"description": "Shortlink handle. Example: abcdefg12",
"type": "string"
},
"expire": {
"description": "Date and time after which the shortlink becomes invalid and can no longer be used",
"type": "string",
"format": "date"
},
"entityTypeId": {
"description": "Unique identifier of entity type.\n * 1 = object,\n * 2 = email_package,\n * 3 = verification_code,\n * 4 = email_preview_package,\n * 5 = file_request,\n * 6 = add_file\n * 7 = password_reset,\n * 8 = gdrive_oauth,\n * 9 = connector_oauth,\n * 10 = comment,\n * 11 = task,\n * 12 = mobile_sync,\n * 13 = password_set,\n * 14 = event,\n * 15 = mail,\n * 16 = approval_request",
"type": "integer"
},
"entityId": {
"description": "Unique identifier of the entity this shortlink points to",
"type": "integer"
},
"length": {
"description": "Number of characters in the generated shortlink handle",
"type": "integer"
},
"addLinks": {
"description": "Indicates whether HATEOAS links should be included in the response",
"type": "boolean"
}
}
},
"GDriveOAuthLink.Put": {
"description": "Class GDriveOAuthLink",
"properties": {
"ref": {
"description": "Shortlink handle. Example: abcdefg12",
"type": "string"
},
"expire": {
"description": "Date and time after which the shortlink becomes invalid and can no longer be used",
"type": "string",
"format": "date"
},
"entityTypeId": {
"description": "Unique identifier of entity type.\n * 1 = object,\n * 2 = email_package,\n * 3 = verification_code,\n * 4 = email_preview_package,\n * 5 = file_request,\n * 6 = add_file\n * 7 = password_reset,\n * 8 = gdrive_oauth,\n * 9 = connector_oauth,\n * 10 = comment,\n * 11 = task,\n * 12 = mobile_sync,\n * 13 = password_set,\n * 14 = event,\n * 15 = mail,\n * 16 = approval_request",
"type": "integer"
},
"entityId": {
"description": "Unique identifier of the entity this shortlink points to",
"type": "integer"
},
"length": {
"description": "Number of characters in the generated shortlink handle",
"type": "integer"
},
"addLinks": {
"description": "Indicates whether HATEOAS links should be included in the response",
"type": "boolean"
}
}
},
"UploadChunk.Post": {
"description": "Class FileUpload",
"properties": {
"index": {
"description": "Chunk index number",
"type": "integer"
},
"compressionMode": {
"description": "Compression mode applied to the chunk. Accepted values: `NORMAL`, `GZIP`, `ZLIB`",
"type": "string"
},
"compressionSize": {
"description": "Size of the compressed chunk in bytes",
"type": "integer"
},
"originalSize": {
"description": "Original (uncompressed) size of the chunk in bytes",
"type": "integer"
},
"content": {
"description": "Chunk binary content (base64-encoded or multipart file upload)",
"type": "string"
},
"lastChunk": {
"description": "Indicates whether this is the last chunk. Accepted values: `0`, `1`",
"type": "integer"
}
}
},
"UploadChunk.Put": {
"description": "Class FileUpload",
"properties": {
"index": {
"description": "Chunk index number",
"type": "integer"
},
"lastChunk": {
"description": "Indicates whether this is the last chunk. Accepted values: `0`, `1`",
"type": "integer"
}
}
},
"UserMe": {
"description": "Class UserMe",
"required": [
"basedirId",
"email",
"id",
"mydirId",
"name",
"syncdirId"
],
"properties": {
"id": {
"description": "The unique identifier of the user",
"type": "string"
},
"basedirId": {
"description": "The unique identifier of the user's root Kiteworks directory.",
"type": "string"
},
"created": {
"description": "Date and time the user account was created",
"type": "string",
"format": "date"
},
"email": {
"description": "The user's email",
"type": "string"
},
"mydirId": {
"description": "The unique identifier of the user's mydir system directory.",
"type": "string"
},
"name": {
"description": "The name of the user",
"type": "string"
},
"syncdirId": {
"description": "The unique identifier of the user's 'My Folder'.",
"type": "string"
},
"userTypeId": {
"description": "The unique identifier of the user type (profile).",
"type": "integer"
},
"internal": {
"description": "Indicates whether the user is an internal user",
"type": "boolean"
},
"profileIcon": {
"description": "URL to the user's profile icon image",
"type": "string"
},
"extDL": {
"description": "Indicates whether the user is an External Distribution List",
"type": "boolean"
},
"metadata": {
"description": "List of user's metadata",
"type": "array",
"items": {
"$ref": "#/components/schemas/UserMetadata"
}
},
"adminRoleId": {
"description": "The ID of the admin role assigned to the user.",
"type": "integer"
},
"links": {
"description": "HATEOAS links associated with the entity",
"type": "array",
"items": {
"type": "string"
}
},
"serviceName": {
"description": "Name of the Kiteworks service instance the user is connected to",
"type": "string"
}
}
},
"UserMe.Post": {
"description": "Class UserMe",
"required": [
"email"
],
"properties": {
"email": {
"description": "The user's email",
"type": "string"
},
"name": {
"description": "The name of the user",
"type": "string"
},
"password": {
"description": "The user's password",
"type": "string"
},
"userTypeId": {
"description": "The unique identifier of the user type",
"type": "integer"
},
"verified": {
"description": "Indicates whether the user is verified",
"type": "boolean"
},
"sendNotification": {
"description": "Indicates whether a notification is sent to the user",
"type": "boolean"
},
"addLinks": {
"description": "Indicates whether HATEOAS links should be included in the response",
"type": "boolean"
}
}
},
"UserMe.Put": {
"description": "Class UserMe",
"properties": {
"suspended": {
"description": "Indicates whether the user is suspended. Set to true to suspend the user.",
"type": "boolean"
},
"name": {
"description": "The name of the user",
"type": "string"
},
"password": {
"description": "The user's password",
"type": "string"
},
"verified": {
"description": "Indicates whether the user is verified",
"type": "boolean"
},
"deactivated": {
"description": "Indicates whether the user is deactivated. Set to true to deactivate the user.",
"type": "boolean"
},
"addLinks": {
"description": "Indicates whether HATEOAS links should be included in the response",
"type": "boolean"
}
}
},
"Tray": {
"description": "Class Tray",
"properties": {
"objectId": {
"description": "Unique identifier of Object in Tray",
"type": "integer"
},
"parentId": {
"description": "Unique identifier of the folder that contains the tray object",
"type": "integer"
},
"canMove": {
"description": "Indicates whether an object can be moved",
"type": "boolean"
},
"object": {
"description": "Full file or folder object associated with this tray entry (Explicit field. May be retrieved only if mentioned in \"with\" parameter)",
"$ref": "#/components/schemas/File"
},
"links": {
"description": "HATEOAS links associated with the entity",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"Tray.Post": {
"description": "Class Tray",
"properties": {
"addLinks": {
"description": "Indicates whether HATEOAS links should be included in the response",
"type": "boolean"
}
}
},
"Tray.Put": {
"description": "Class Tray",
"properties": {
"addLinks": {
"description": "Indicates whether HATEOAS links should be included in the response",
"type": "boolean"
}
}
},
"Shortlink": {
"description": "Class Shortlink",
"properties": {
"expire": {
"description": "Date and time after which the shortlink becomes invalid and can no longer be used",
"type": "string",
"format": "date"
},
"entityTypeId": {
"description": "Unique identifier of the entity type this shortlink is associated with",
"type": "integer"
},
"entityId": {
"description": "Unique identifier of the entity this shortlink points to, returned as a GUID from version 19 onwards",
"type": "string"
},
"entityTypeName": {
"description": "Human-readable name of the entity type this shortlink is associated with",
"type": "string"
},
"links": {
"description": "HATEOAS links associated with the entity",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"Shortlink.Post": {
"description": "Class Shortlink",
"properties": {
"ref": {
"description": "Shortlink handle. Example: abcdefg12",
"type": "string"
},
"expire": {
"description": "Date and time after which the shortlink becomes invalid and can no longer be used",
"type": "string",
"format": "date"
},
"entityTypeId": {
"description": "Unique identifier of entity type.\n * 1 = object,\n * 2 = email_package,\n * 3 = verification_code,\n * 4 = email_preview_package,\n * 5 = file_request,\n * 6 = add_file\n * 7 = password_reset,\n * 8 = gdrive_oauth,\n * 9 = connector_oauth,\n * 10 = comment,\n * 11 = task,\n * 12 = mobile_sync,\n * 13 = password_set,\n * 14 = event,\n * 15 = mail,\n * 16 = approval_request",
"type": "integer"
},
"entityId": {
"description": "Unique identifier of the entity this shortlink points to",
"type": "integer"
},
"length": {
"description": "Number of characters in the generated shortlink handle",
"type": "integer"
},
"addLinks": {
"description": "Indicates whether HATEOAS links should be included in the response",
"type": "boolean"
}
}
},
"Shortlink.Put": {
"description": "Class Shortlink",
"properties": {
"ref": {
"description": "Shortlink handle. Example: abcdefg12",
"type": "string"
},
"expire": {
"description": "Date and time after which the shortlink becomes invalid and can no longer be used",
"type": "string",
"format": "date"
},
"entityTypeId": {
"description": "Unique identifier of entity type.\n * 1 = object,\n * 2 = email_package,\n * 3 = verification_code,\n * 4 = email_preview_package,\n * 5 = file_request,\n * 6 = add_file\n * 7 = password_reset,\n * 8 = gdrive_oauth,\n * 9 = connector_oauth,\n * 10 = comment,\n * 11 = task,\n * 12 = mobile_sync,\n * 13 = password_set,\n * 14 = event,\n * 15 = mail,\n * 16 = approval_request",
"type": "integer"
},
"entityId": {
"description": "Unique identifier of the entity this shortlink points to",
"type": "integer"
},
"length": {
"description": "Number of characters in the generated shortlink handle",
"type": "integer"
},
"addLinks": {
"description": "Indicates whether HATEOAS links should be included in the response",
"type": "boolean"
}
}
},
"VerificationCodeLink": {
"description": "Class VerificationCodeLink",
"properties": {
"expire": {
"description": "Date and time after which the shortlink becomes invalid and can no longer be used",
"type": "string",
"format": "date"
},
"entityTypeId": {
"description": "Unique identifier of the entity type this shortlink is associated with",
"type": "integer"
},
"entityId": {
"description": "Unique identifier of the entity this shortlink points to, returned as a GUID from version 19 onwards",
"type": "string"
},
"entityTypeName": {
"description": "Human-readable name of the entity type this shortlink is associated with",
"type": "string"
},
"links": {
"description": "HATEOAS links associated with the entity",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"VerificationCodeLink.Post": {
"description": "Class VerificationCodeLink",
"properties": {
"ref": {
"description": "Shortlink handle. Example: abcdefg12",
"type": "string"
},
"expire": {
"description": "Date and time after which the shortlink becomes invalid and can no longer be used",
"type": "string",
"format": "date"
},
"entityTypeId": {
"description": "Unique identifier of entity type.\n * 1 = object,\n * 2 = email_package,\n * 3 = verification_code,\n * 4 = email_preview_package,\n * 5 = file_request,\n * 6 = add_file\n * 7 = password_reset,\n * 8 = gdrive_oauth,\n * 9 = connector_oauth,\n * 10 = comment,\n * 11 = task,\n * 12 = mobile_sync,\n * 13 = password_set,\n * 14 = event,\n * 15 = mail,\n * 16 = approval_request",
"type": "integer"
},
"entityId": {
"description": "Unique identifier of the entity this shortlink points to",
"type": "integer"
},
"length": {
"description": "Number of characters in the generated shortlink handle",
"type": "integer"
},
"addLinks": {
"description": "Indicates whether HATEOAS links should be included in the response",
"type": "boolean"
}
}
},
"VerificationCodeLink.Put": {
"description": "Class VerificationCodeLink",
"properties": {
"ref": {
"description": "Shortlink handle. Example: abcdefg12",
"type": "string"
},
"expire": {
"description": "Date and time after which the shortlink becomes invalid and can no longer be used",
"type": "string",
"format": "date"
},
"entityTypeId": {
"description": "Unique identifier of entity type.\n * 1 = object,\n * 2 = email_package,\n * 3 = verification_code,\n * 4 = email_preview_package,\n * 5 = file_request,\n * 6 = add_file\n * 7 = password_reset,\n * 8 = gdrive_oauth,\n * 9 = connector_oauth,\n * 10 = comment,\n * 11 = task,\n * 12 = mobile_sync,\n * 13 = password_set,\n * 14 = event,\n * 15 = mail,\n * 16 = approval_request",
"type": "integer"
},
"entityId": {
"description": "Unique identifier of the entity this shortlink points to",
"type": "integer"
},
"length": {
"description": "Number of characters in the generated shortlink handle",
"type": "integer"
},
"addLinks": {
"description": "Indicates whether HATEOAS links should be included in the response",
"type": "boolean"
}
}
},
"Task": {
"description": "Class Task",
"required": [
"assigneeId",
"created",
"due",
"id",
"status",
"userId"
],
"properties": {
"id": {
"description": "Task unique identifier",
"type": "integer"
},
"assigneeId": {
"description": "Assigned User unique identifier",
"type": "string"
},
"assignee": {
"description": "User assigned to complete the task (Explicit field. May be retrieved only if mentioned in \"with\" parameter)",
"$ref": "#/components/schemas/User"
},
"due": {
"description": "Date and time by which the task must be completed",
"type": "string",
"format": "date"
},
"parentId": {
"description": "Parent Comment identifier",
"type": "integer"
},
"objectId": {
"description": "Object identifier Task belongs to",
"type": "string"
},
"userId": {
"description": "Identifier of User who created a Task",
"type": "string"
},
"user": {
"description": "User who created the task (Explicit field. May be retrieved only if mentioned in \"with\" parameter)",
"$ref": "#/components/schemas/User"
},
"created": {
"description": "Date and time the task was created",
"type": "string",
"format": "date"
},
"modified": {
"description": "Date and time the task was last modified",
"type": "string",
"format": "date"
},
"contents": {
"description": "Body text of the task",
"type": "string"
},
"deleted": {
"description": "Indicates whether the task is deleted",
"type": "boolean"
},
"folderId": {
"description": "Identifier of Object's parent Folder",
"type": "string"
},
"status": {
"description": "Task status. Accepted values: `D` (Defined), `P` (In Progress), `C` (Completed)",
"type": "string"
},
"file": {
"description": "File the task is tied to (Explicit field. May be retrieved only if mentioned in \"with\" parameter)",
"$ref": "#/components/schemas/File"
},
"permissions": {
"description": "Current user's permissions (Explicit field. May be retrieved only if mentioned in \"with\" parameter)",
"type": "array",
"items": {
"$ref": "#/components/schemas/Permission"
}
},
"links": {
"description": "HATEOAS links associated with the entity",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"Task.Post": {
"description": "Class Task",
"required": [
"assigneeId",
"due",
"contents"
],
"properties": {
"assigneeId": {
"description": "Assignee user unique identifier",
"type": "integer"
},
"due": {
"description": "Date and time by which the task must be completed",
"type": "string",
"format": "date"
},
"parentId": {
"description": "Parent Comment identifier",
"type": "integer"
},
"contents": {
"description": "Body text of the task",
"type": "string"
},
"addLinks": {
"description": "Indicates whether HATEOAS links should be included in the response",
"type": "boolean"
}
}
},
"Task.Put": {
"description": "Class Task",
"required": [
"assigneeId",
"due",
"contents"
],
"properties": {
"assigneeId": {
"description": "Assignee user unique identifier",
"type": "integer"
},
"due": {
"description": "Date and time by which the task must be completed",
"type": "string",
"format": "date"
},
"contents": {
"description": "Body text of the task",
"type": "string"
},
"status": {
"description": "'D' = 'Defined', 'P' = 'In Progress', 'C' = 'Completed'",
"type": "string",
"enum": [
"D",
"P",
"C"
]
},
"addLinks": {
"description": "Indicates whether HATEOAS links should be included in the response",
"type": "boolean"
}
}
},
"File": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"description": "Unique identifier (UUID) of the file."
},
"parentId": {
"type": "string",
"format": "uuid",
"description": "Unique identifier (UUID) of the parent folder."
},
"name": {
"type": "string",
"description": "Name of the object."
},
"type": {
"type": "string",
"description": "Type of the object.
`f` \u2013 File.
`d` \u2013 Folder."
},
"userId": {
"type": "string",
"format": "uuid",
"description": "Unique identifier (UUID) who created the file."
},
"creator": {
"description": "Details of the user who created the object.",
"allOf": [
{
"$ref": "#/components/schemas/UserBasic"
}
]
},
"created": {
"type": "string",
"format": "date",
"description": "The date and time when the object was created."
},
"modified": {
"type": "string",
"format": "date",
"description": "The date and time when the object was last modified."
},
"expire": {
"type": "string",
"format": "date",
"description": "Expiration timestamp of the object, if applicable."
},
"permissions": {
"description": "List of permissions associated with the object.",
"type": "array",
"items": {
"$ref": "#/components/schemas/Permission"
}
},
"deleted": {
"type": "boolean",
"description": "Indicates whether the object has been deleted."
},
"permDeleted": {
"type": "boolean",
"description": "Indicates whether the object has been permanently deleted."
},
"permalink": {
"type": "string",
"description": "Permanent URL link to access the file."
},
"path": {
"type": "string",
"description": "Path to the object in the hierarchy."
},
"members": {
"description": "List of members who have access to the object.",
"type": "array",
"items": {
"$ref": "#/components/schemas/Member"
}
},
"vendorDocId": {
"type": "string",
"description": "Vendor document ID associated with the object."
},
"vendorDocName": {
"type": "string",
"description": "Name of the vendor document associated with the object."
},
"secure": {
"type": "boolean",
"description": "Indicates whether the folder or the parent folder containing the file is marked as secure."
},
"source": {
"type": "integer",
"description": "ID representing the source of the object (1 - Salesforce, 2 - Teams)."
},
"modifier": {
"description": "The user who last modified the file.",
"allOf": [
{
"$ref": "#/components/schemas/UserBasic"
}
]
},
"size": {
"type": "integer",
"description": "The size of the file in bytes."
},
"mime": {
"type": "string",
"description": "The MIME type of the file."
},
"fingerprint": {
"type": "string",
"description": "A unique hash identifying the file."
},
"fingerprints": {
"type": "array",
"description": "List of fingerprints associated with the file.",
"items": {
"$ref": "#/components/schemas/Fingerprint"
}
},
"clientCreated": {
"type": "string",
"format": "date",
"description": "The date and time when the file was created on the client side."
},
"clientModified": {
"type": "string",
"format": "date",
"description": "The date and time when the file was last modified on the client side."
},
"overriddenExpire": {
"type": "boolean",
"description": "Indicates whether the expiration date for the file has been overridden."
},
"sharedBy": {
"description": "The user who shared the file.",
"allOf": [
{
"$ref": "#/components/schemas/UserBasic"
}
]
},
"sharedTime": {
"type": "string",
"format": "date",
"description": "The date and time when the file was shared."
},
"parent": {
"description": "The parent folder of the file.",
"allOf": [
{
"$ref": "#/components/schemas/Folder"
}
]
},
"originalFileId": {
"type": "string",
"format": "uuid",
"description": "The ID of the original file if this one is a copy."
},
"avStatus": {
"type": "string",
"description": "Indicates the file version's availability status based on Antivirus (AV) settings and whether it has been scanned or detected as infected."
},
"dlpStatus": {
"type": "string",
"description": "Indicates the file version's availability status based on Data Loss Prevention (DLP) settings and whether it has been scanned or detected as infected."
},
"adminQuarantineStatus": {
"type": "string",
"description": "Indicates the file version's availability status based on the administrator's quarantine status."
},
"locked": {
"type": "boolean",
"description": "Indicates if the file is locked."
},
"lockUser": {
"description": "The user who locked the file.",
"allOf": [
{
"$ref": "#/components/schemas/UserBasic"
}
]
},
"isShared": {
"type": "boolean",
"description": "Indicates if the file is shared with other users."
},
"lastModifiedBy": {
"description": "The user who last modified the file.",
"allOf": [
{
"$ref": "#/components/schemas/UserBasic"
}
]
},
"pushedObject": {
"description": "Details about the pushed object, if any.",
"allOf": [
{
"$ref": "#/components/schemas/PushedObject"
}
]
},
"pathIds": {
"type": "string",
"format": "uuid",
"description": "A list of IDs representing the path of the file within the folder hierarchy."
},
"wopiapp": {
"description": "WOPI-related information for the file when used in a mobile app.",
"allOf": [
{
"$ref": "#/components/schemas/MobileInfo"
}
]
},
"pushed": {
"type": "boolean",
"description": "Indicates if the file has been pushed to a mobile app."
},
"tags": {
"description": "List of tags associated with the file.",
"type": "array",
"items": {
"$ref": "#/components/schemas/Tag"
}
},
"safeEdit": {
"description": "Information regarding the file's SafeEdit settings.",
"allOf": [
{
"$ref": "#/components/schemas/SafeEdit"
}
]
},
"versionsCount": {
"type": "integer",
"description": "The total number of versions for the file."
},
"tracking_id": {
"type": "string",
"format": "uuid",
"nullable": true,
"description": "Tracking identifier associated with the file upload."
}
}
},
"File.Post": {
"description": "Class File",
"required": [
"name"
],
"properties": {
"addLinks": {
"description": "Indicates whether HATEOAS links should be included in the response",
"type": "boolean"
},
"name": {
"description": "Display name of the file",
"type": "string"
}
}
},
"File.Put": {
"description": "Class File",
"required": [
"name"
],
"properties": {
"addLinks": {
"description": "Indicates whether HATEOAS links should be included in the response",
"type": "boolean"
},
"name": {
"description": "Display name of the file",
"type": "string"
},
"expire": {
"description": "The file expiration date.",
"type": "string"
},
"replace": {
"description": "Replace the file if file with same name exists",
"type": "string"
}
}
},
"ECSource": {
"description": "Class ECSource",
"required": [
"id"
],
"properties": {
"id": {
"description": "Repositories Gateway Source unique identifier",
"type": "integer"
},
"sourceTypeId": {
"description": "Repositories Gateway Source type unique identifier",
"type": "integer"
},
"basePath": {
"description": "Root path used as the starting point for browsing the Repositories Gateway Source",
"type": "string"
},
"url": {
"description": "Connection URL for the Repositories Gateway Source",
"type": "string"
}
}
},
"ClientNew": {
"description": "Class ClientNew",
"required": [
"id",
"name"
],
"properties": {
"id": {
"description": "Unique Client identifier",
"type": "string"
},
"name": {
"description": "Display name of the client application",
"type": "string"
},
"description": {
"description": "Human-readable description of the client application and its purpose",
"type": "string"
},
"redirectUri": {
"description": "Redirect URL of this client",
"type": "string"
},
"scope": {
"description": "API entities which this client can access",
"type": "string"
},
"flag": {
"description": "Flags for Client. e.g. NO_CONSENT:1, DISABLED:2, HIDDEN:4, NO_EXPIRY_TOKEN :8",
"type": "integer"
},
"flow": {
"description": "Oauth flow for this client.\n e.g. AUTH_CODE:1, CLIENT_CREDENTIAL:2, SIGNATURE:4, REFRESH_TOKEN:8",
"type": "integer"
},
"signatureKey": {
"description": "Secret key used to sign requests made by this client",
"type": "string"
},
"accessTokenLifetime": {
"description": "Life time for access token of client in hours. e.g. 5=5 hours",
"type": "integer"
},
"refreshTokenLifetime": {
"description": "Life time for refresh token of client in hours",
"type": "integer"
},
"whiteList": {
"description": "List of applications on the device that the client can call out to",
"type": "string"
},
"askPin": {
"description": "Indicates whether a PIN should be requested of the user using this client",
"type": "integer"
},
"pinTimeout": {
"description": "Time out for pin of client in minutes",
"type": "integer"
},
"maxPinAttempts": {
"description": "Max attempts that user can try to enter PIN before wipe occurs",
"type": "integer"
},
"type": {
"description": "Client Type. e.g. ACCELLION:1, MOBILE:2, OUTLOOK:4, SYNC:8, IMPORTED:32",
"type": "integer"
},
"touchId": {
"description": "Indicates whether touch Id is enabled",
"type": "boolean"
},
"clipboardEnabled": {
"description": "Indicates whether clipboard is enabled",
"type": "boolean"
},
"autoUpdate": {
"description": "Indicates whether auto update is enabled",
"type": "boolean"
},
"installer": {
"description": "Installer information for the client",
"type": "string"
},
"emailMatch": {
"description": "Indicates whether the external email matches a Kiteworks email",
"type": "boolean"
},
"minVersion": {
"description": "Minimum API version required by this client to operate correctly",
"type": "integer"
},
"links": {
"description": "HATEOAS links associated with the entity",
"type": "array",
"items": {
"type": "string"
}
},
"clientSecret": {
"description": "Plain-text client secret returned only at creation time",
"type": "string"
}
}
},
"ClientNew.Post": {
"description": "Class ClientNew",
"required": [
"description",
"name",
"redirectUri",
"scope"
],
"properties": {
"name": {
"description": "Display name of the client application",
"type": "string"
},
"description": {
"description": "Human-readable description of the client application and its purpose",
"type": "string"
},
"redirectUri": {
"description": "Where the server send the code that client can redeem access token.\n e.g. https://HOST/rest/callback.html",
"type": "string"
},
"scope": {
"description": "API entities which this client can access",
"type": "string"
},
"signatureKey": {
"description": "Secret key used to sign requests made by this client",
"type": "string"
},
"accessTokenLifetime": {
"description": "Life time for access token of client in hours. e.g. 5=5 hours",
"type": "integer"
},
"refreshTokenLifetime": {
"description": "Life time for refresh token of client in hours",
"type": "integer"
},
"addLinks": {
"description": "Indicates whether HATEOAS links should be included in the response",
"type": "boolean"
}
}
},
"ClientNew.Put": {
"description": "Class ClientNew",
"required": [
"description",
"name",
"redirectUri",
"scope"
],
"properties": {
"name": {
"description": "Display name of the client application",
"type": "string"
},
"description": {
"description": "Human-readable description of the client application and its purpose",
"type": "string"
},
"redirectUri": {
"description": "Where the server send the code that client can redeem access token.\n e.g. https://HOST/rest/callback.html",
"type": "string"
},
"scope": {
"description": "API entities which this client can access",
"type": "string"
},
"signatureKey": {
"description": "Secret key used to sign requests made by this client",
"type": "string"
},
"accessTokenLifetime": {
"description": "Life time for access token of client in hours. e.g. 5=5 hours",
"type": "integer"
},
"refreshTokenLifetime": {
"description": "Life time for refresh token of client in hours",
"type": "integer"
},
"addLinks": {
"description": "Indicates whether HATEOAS links should be included in the response",
"type": "boolean"
}
}
},
"BaseFolder": {
"required": [
"id",
"name",
"parentId",
"userId"
],
"properties": {
"id": {
"description": "Unique identifier of object",
"type": "string"
},
"created": {
"description": "Date and time when the object was created",
"type": "string",
"format": "date-time"
},
"deleted": {
"description": "Indicates whether the object is deleted",
"type": "boolean"
},
"permDeleted": {
"description": "Indicates whether the object is permanently deleted",
"type": "boolean"
},
"expire": {
"description": "Date and time when the object expires and becomes inaccessible",
"type": "string",
"format": "date-time"
},
"modified": {
"description": "Date and time when the object was last modified",
"type": "string",
"format": "date-time"
},
"name": {
"description": "Display name of the object",
"type": "string"
},
"parentId": {
"description": "Parent Folder identifier",
"type": "string"
},
"userId": {
"description": "Unique identifier of Object creator",
"type": "string"
},
"parent": {
"description": "Folder that directly contains this object (Explicit field. May be retrieved only if mentioned in \"with\" parameter)",
"$ref": "#/components/schemas/Folder"
},
"permalink": {
"description": "Permanent URL for accessing the object in the web application",
"type": "string"
},
"creator": {
"description": "Basic profile information of the user who created the object (Explicit field. May be retrieved only if mentioned in \"with\" parameter)",
"$ref": "#/components/schemas/UserBasicInfo"
},
"permissions": {
"description": "Current user's permissions (Explicit field. May be retrieved only if mentioned in \"with\" parameter)",
"type": "array",
"items": {
"$ref": "#/components/schemas/Permission"
}
},
"vendorDocId": {
"description": "Identifier of the corresponding document in the external vendor system (Explicit field. May be retrieved only if mentioned in \"with\" parameter)",
"type": "string"
},
"vendorDocName": {
"description": "Display name of the corresponding document in the external vendor system (Explicit field. May be retrieved only if mentioned in \"with\" parameter)",
"type": "string"
},
"source": {
"description": "Numeric code identifying the external system that originated this object (e.g. Salesforce, Teams)",
"type": "integer"
},
"links": {
"description": "HATEOAS links associated with the entity",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"BaseFolder.Post": {
"required": [
"name"
],
"properties": {
"addLinks": {
"description": "Indicates whether HATEOAS links should be included in the response",
"type": "boolean"
},
"name": {
"description": "Display name of the folder",
"type": "string"
}
}
},
"BaseFolder.Put": {
"required": [
"name"
],
"properties": {
"addLinks": {
"description": "Indicates whether HATEOAS links should be included in the response",
"type": "boolean"
},
"name": {
"description": "Display name of the folder",
"type": "string"
}
}
},
"FileAddedNotificationJob": {
"properties": {
"id": {
"description": "Job unique identifier",
"type": "string"
},
"status": {
"description": "Current job status. Accepted values: `queued`, `working`, `succeeded`, `failed`",
"type": "string"
},
"errors": {
"description": "List of errors that occurred during job processing",
"type": "string"
},
"objectIds": {
"description": "List of object IDs associated with this job",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"Hostname": {
"description": "Class Hostname",
"required": [
"id"
],
"properties": {
"id": {
"description": "Hostname unique identifier",
"type": "integer"
},
"hostname": {
"description": "Hostname",
"type": "string"
},
"deleted": {
"description": "Indicates whether the hostname is deleted",
"type": "boolean"
},
"disabled": {
"description": "Indicates whether the hostname is disabled",
"type": "boolean"
},
"links": {
"description": "HATEOAS links associated with the entity",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"Hostname.Post": {
"description": "Class Hostname",
"required": [
"hostname"
],
"properties": {
"hostname": {
"description": "Hostname",
"type": "string"
},
"disabled": {
"description": "Disable hostname",
"type": "boolean"
},
"addLinks": {
"description": "Indicates whether HATEOAS links should be included in the response",
"type": "boolean"
}
}
},
"Hostname.Put": {
"description": "Class Hostname",
"properties": {
"disabled": {
"description": "Disable hostname",
"type": "boolean"
},
"addLinks": {
"description": "Indicates whether HATEOAS links should be included in the response",
"type": "boolean"
}
}
},
"Attachment": {
"type": "object",
"properties": {
"emailPackageId": {
"type": "string",
"format": "uuid",
"description": "Unique identifier for the email package containing the attachment."
},
"attachmentId": {
"type": "string",
"description": "Unique identifier for the attachment."
},
"withdrawn": {
"type": "boolean",
"description": "Indicates whether the attachment has been withdrawn."
},
"drmFile": {
"description": "Details of the DRM-protected file associated with the attachment.",
"allOf": [
{
"$ref": "#/components/schemas/DrmFile"
}
]
},
"accessType": {
"type": "integer",
"description": "Access type for the attachment (e.g., read-only, editable)."
},
"tags": {
"description": "List of tags associated with the attachment.",
"type": "array",
"items": {
"$ref": "#/components/schemas/Tag"
}
},
"permissions": {
"type": "array",
"description": "List of permissions associated with the attachment.",
"items": {
"$ref": "#/components/schemas/Permission"
}
},
"objectId": {
"type": "string",
"format": "uuid",
"description": "Unique identifier for the file associated with the attachment."
},
"name": {
"type": "string",
"description": "Name of the attachment file."
},
"size": {
"type": "integer",
"description": "Size of the attachment file in bytes."
},
"mime": {
"type": "string",
"description": "The MIME type of the attachment file."
},
"created": {
"type": "string",
"format": "date",
"description": "Date when the attachment file was created."
},
"deleted": {
"type": "boolean",
"description": "Indicates if the attachment has been deleted."
},
"fingerprint": {
"type": "string",
"description": "A unique hash identifying the file version."
},
"fingerprintAlgo": {
"type": "string",
"description": "The algorithm used for generating the file version fingerprint. (e.g., sha3-256, md5)."
},
"fingerprints": {
"description": "List of alternative fingerprints for the attachment file.",
"type": "array",
"items": {
"$ref": "#/components/schemas/Fingerprint"
}
},
"adminQuarantineStatus": {
"type": "string",
"description": "Status of the attachment in the admin quarantine system."
},
"avStatus": {
"type": "string",
"description": "Antivirus (AV) scan status of the attachment."
},
"dlpStatus": {
"type": "string",
"description": "Data Loss Prevention (DLP) status of the attachment."
}
}
},
"Attachment.Post": {
"description": "Class Attachment",
"properties": {
"addLinks": {
"description": "Indicates whether HATEOAS links should be included in the response",
"type": "boolean"
}
}
},
"Attachment.Put": {
"description": "Class Attachment",
"properties": {
"emailPackageId": {
"description": "Unique identifier of Email Package which contains attachment.",
"type": "integer"
},
"attachmentId": {
"description": "Unique identifier of attachment",
"type": "string"
},
"addLinks": {
"description": "Indicates whether HATEOAS links should be included in the response",
"type": "boolean"
}
}
},
"Permission": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "Unique identifier for the permission."
},
"name": {
"type": "string",
"description": "Name of the permission."
},
"allowed": {
"type": "boolean",
"description": "Indicates whether the permission is granted (True) or denied (False)."
}
}
},
"Storage": {
"description": "Class DailyBandwidth",
"properties": {
"dateTime": {
"description": "Storage measurement date",
"type": "string",
"format": "date"
},
"usage": {
"description": "Storage usage in bytes",
"type": "integer"
}
}
},
"MailLink": {
"description": "Class MailLink",
"properties": {
"expire": {
"description": "Date and time after which the shortlink becomes invalid and can no longer be used",
"type": "string",
"format": "date"
},
"entityTypeId": {
"description": "Unique identifier of the entity type this shortlink is associated with",
"type": "integer"
},
"entityId": {
"description": "Unique identifier of the entity this shortlink points to, returned as a GUID from version 19 onwards",
"type": "string"
},
"entityTypeName": {
"description": "Human-readable name of the entity type this shortlink is associated with",
"type": "string"
},
"links": {
"description": "HATEOAS links associated with the entity",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"MailLink.Post": {
"description": "Class MailLink",
"properties": {
"ref": {
"description": "Shortlink handle. Example: abcdefg12",
"type": "string"
},
"expire": {
"description": "Date and time after which the shortlink becomes invalid and can no longer be used",
"type": "string",
"format": "date"
},
"entityTypeId": {
"description": "Unique identifier of entity type.\n * 1 = object,\n * 2 = email_package,\n * 3 = verification_code,\n * 4 = email_preview_package,\n * 5 = file_request,\n * 6 = add_file\n * 7 = password_reset,\n * 8 = gdrive_oauth,\n * 9 = connector_oauth,\n * 10 = comment,\n * 11 = task,\n * 12 = mobile_sync,\n * 13 = password_set,\n * 14 = event,\n * 15 = mail,\n * 16 = approval_request",
"type": "integer"
},
"entityId": {
"description": "Unique identifier of the entity this shortlink points to",
"type": "integer"
},
"length": {
"description": "Number of characters in the generated shortlink handle",
"type": "integer"
},
"addLinks": {
"description": "Indicates whether HATEOAS links should be included in the response",
"type": "boolean"
}
}
},
"MailLink.Put": {
"description": "Class MailLink",
"properties": {
"ref": {
"description": "Shortlink handle. Example: abcdefg12",
"type": "string"
},
"expire": {
"description": "Date and time after which the shortlink becomes invalid and can no longer be used",
"type": "string",
"format": "date"
},
"entityTypeId": {
"description": "Unique identifier of entity type.\n * 1 = object,\n * 2 = email_package,\n * 3 = verification_code,\n * 4 = email_preview_package,\n * 5 = file_request,\n * 6 = add_file\n * 7 = password_reset,\n * 8 = gdrive_oauth,\n * 9 = connector_oauth,\n * 10 = comment,\n * 11 = task,\n * 12 = mobile_sync,\n * 13 = password_set,\n * 14 = event,\n * 15 = mail,\n * 16 = approval_request",
"type": "integer"
},
"entityId": {
"description": "Unique identifier of the entity this shortlink points to",
"type": "integer"
},
"length": {
"description": "Number of characters in the generated shortlink handle",
"type": "integer"
},
"addLinks": {
"description": "Indicates whether HATEOAS links should be included in the response",
"type": "boolean"
}
}
},
"Template": {
"description": "Class Template",
"properties": {
"id": {
"description": "Template unique identifier",
"type": "integer"
},
"name": {
"description": "Display name of the email template",
"type": "string"
},
"subject": {
"description": "Subject line of the email template",
"type": "string"
},
"body": {
"description": "HTML body content of the email template",
"type": "string"
},
"buttonLink": {
"description": "Template button link URL",
"type": "string"
},
"buttonText": {
"description": "Template button display text",
"type": "string"
},
"links": {
"description": "HATEOAS links associated with the entity",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"Template.Post": {
"description": "Class Template",
"properties": {
"addLinks": {
"description": "Indicates whether HATEOAS links should be included in the response",
"type": "boolean"
}
}
},
"Template.Put": {
"description": "Class Template",
"properties": {
"addLinks": {
"description": "Indicates whether HATEOAS links should be included in the response",
"type": "boolean"
}
}
},
"KitepointDirectory": {
"description": "Class KitepointDirectory",
"required": [
"id",
"name",
"parentId",
"userId"
],
"properties": {
"id": {
"description": "Unique identifier of object",
"type": "string"
},
"created": {
"description": "Date and time when the object was created",
"type": "string",
"format": "date-time"
},
"deleted": {
"description": "Indicates whether the object is deleted",
"type": "boolean"
},
"permDeleted": {
"description": "Indicates whether the object is permanently deleted",
"type": "boolean"
},
"expire": {
"description": "Date and time when the object expires and becomes inaccessible",
"type": "string",
"format": "date-time"
},
"modified": {
"description": "Date and time when the object was last modified",
"type": "string",
"format": "date-time"
},
"name": {
"description": "Display name of the object",
"type": "string"
},
"userId": {
"description": "Unique identifier of Object creator",
"type": "string"
},
"parent": {
"description": "Folder that directly contains this object (Explicit field. May be retrieved only if mentioned in \"with\" parameter)",
"$ref": "#/components/schemas/Folder"
},
"permalink": {
"description": "Permanent URL for accessing the object in the web application",
"type": "string"
},
"creator": {
"description": "Basic profile information of the user who created the object (Explicit field. May be retrieved only if mentioned in \"with\" parameter)",
"$ref": "#/components/schemas/UserBasicInfo"
},
"permissions": {
"description": "Current user's permissions (Explicit field. May be retrieved only if mentioned in \"with\" parameter)",
"type": "array",
"items": {
"$ref": "#/components/schemas/Permission"
}
},
"vendorDocId": {
"description": "Identifier of the corresponding document in the external vendor system (Explicit field. May be retrieved only if mentioned in \"with\" parameter)",
"type": "string"
},
"vendorDocName": {
"description": "Display name of the corresponding document in the external vendor system (Explicit field. May be retrieved only if mentioned in \"with\" parameter)",
"type": "string"
},
"source": {
"description": "Numeric code identifying the external system that originated this object (e.g. Salesforce, Teams)",
"type": "integer"
},
"links": {
"description": "HATEOAS links associated with the entity",
"type": "array",
"items": {
"type": "string"
}
},
"type": {
"description": "Object type. Accepted values: `kd` for kitepoint folder",
"type": "string"
},
"path": {
"description": "Full folder path from the root to this directory, showing all ancestor folder names",
"type": "string"
},
"parentId": {
"description": "Unique identifier of the parent folder containing this directory",
"type": "string"
},
"isFavorite": {
"description": "Indicates whether the folder is marked as a favourite by the current user (Explicit field. May be retrieved only if mentioned in \"with\" parameter)",
"type": "boolean"
},
"eCObject": {
"description": "EC object unique identifier of kitepoint directory",
"$ref": "#/components/schemas/ECObject"
},
"eCUUID": {
"description": "EC object universally unique identifier",
"type": "string"
}
}
},
"KitepointDirectory.Post": {
"description": "Class KitepointDirectory",
"required": [
"name"
],
"properties": {
"addLinks": {
"description": "Indicates whether HATEOAS links should be included in the response",
"type": "boolean"
},
"name": {
"description": "Display name of the folder",
"type": "string"
}
}
},
"KitepointDirectory.Put": {
"description": "Class KitepointDirectory",
"required": [
"name"
],
"properties": {
"addLinks": {
"description": "Indicates whether HATEOAS links should be included in the response",
"type": "boolean"
},
"name": {
"description": "Display name of the folder",
"type": "string"
}
}
},
"DliFile": {
"description": "Class DliFile",
"required": [
"id",
"locked",
"name",
"parentId",
"size",
"type",
"userId",
"wopiapp"
],
"properties": {
"id": {
"description": "Unique identifier of object",
"type": "string"
},
"created": {
"description": "Date and time when the object was created",
"type": "string",
"format": "date-time"
},
"deleted": {
"description": "Indicates whether the object is deleted",
"type": "boolean"
},
"permDeleted": {
"description": "Indicates whether the object is permanently deleted",
"type": "boolean"
},
"expire": {
"description": "Date and time when the object expires and becomes inaccessible",
"type": "string",
"format": "date-time"
},
"modified": {
"description": "Date and time when the object was last modified",
"type": "string",
"format": "date-time"
},
"name": {
"description": "Display name of the object",
"type": "string"
},
"parentId": {
"description": "Parent Folder identifier",
"type": "string"
},
"userId": {
"description": "Unique identifier of Object creator",
"type": "string"
},
"parent": {
"description": "Folder that directly contains this object (Explicit field. May be retrieved only if mentioned in \"with\" parameter)",
"$ref": "#/components/schemas/Folder"
},
"permalink": {
"description": "Permanent URL for accessing the object in the web application",
"type": "string"
},
"creator": {
"description": "Basic profile information of the user who created the object (Explicit field. May be retrieved only if mentioned in \"with\" parameter)",
"$ref": "#/components/schemas/UserBasicInfo"
},
"permissions": {
"description": "Current user's permissions (Explicit field. May be retrieved only if mentioned in \"with\" parameter)",
"type": "array",
"items": {
"$ref": "#/components/schemas/Permission"
}
},
"vendorDocId": {
"description": "Identifier of the corresponding document in the external vendor system (Explicit field. May be retrieved only if mentioned in \"with\" parameter)",
"type": "string"
},
"vendorDocName": {
"description": "Display name of the corresponding document in the external vendor system (Explicit field. May be retrieved only if mentioned in \"with\" parameter)",
"type": "string"
},
"source": {
"description": "Numeric code identifying the external system that originated this object (e.g. Salesforce, Teams)",
"type": "integer"
},
"links": {
"description": "HATEOAS links associated with the entity",
"type": "array",
"items": {
"type": "string"
}
},
"mime": {
"description": "File MIME type",
"type": "string"
},
"size": {
"description": "Size of the file content in bytes",
"type": "string"
},
"fingerprint": {
"description": "Cryptographic fingerprint (hash) of the file content used for integrity verification",
"type": "string"
},
"tracking_id": {
"description": "File tracking ID (UUID)",
"type": "string"
},
"type": {
"type": "string"
},
"locked": {
"description": "Unique identifier of User who locked a File",
"type": "integer"
},
"lockUser": {
"description": "User who locked the File (Explicit field. May be retrieved only if mentioned in \"with\" parameter)",
"$ref": "#/components/schemas/User"
},
"clientCreated": {
"description": "Original created time of the file",
"type": "string",
"format": "date"
},
"clientModified": {
"description": "Original modified time of the file",
"type": "string",
"format": "date"
},
"members": {
"description": "File members list (Explicit field. May be retrieved only if mentioned in \"with\" parameter)",
"type": "array",
"items": {
"$ref": "#/components/schemas/Member"
}
},
"overriddenExpire": {
"description": "Indicates whether the file expiration date is overridden",
"type": "boolean"
},
"originalFileId": {
"description": "File identifier from which this file was copied from",
"type": "string"
},
"pushedObject": {
"description": "Contains pushedObject data if current file was ever pushed (Explicit field. May be retrieved only if mentioned in \"with\" parameter)",
"$ref": "#/components/schemas/PushedObject"
},
"avStatus": {
"description": "Check file availability status according to AV settings and file scanned/infected status",
"type": "string"
},
"dlpStatus": {
"description": "Check file availability status according to DLP settings and file scanned/infected status",
"type": "string"
},
"adminQuarantineStatus": {
"description": "Check file availability status according to admin quarantined status",
"type": "string"
},
"storageAvailable": {
"description": "Boolean value that shows if this file is available on any volume",
"type": "boolean"
},
"lastModifiedBy": {
"description": "Creator of the latest version (Explicit field. May be retrieved only if mentioned in \"with\" parameter)",
"$ref": "#/components/schemas/User"
},
"wopiapp": {
"description": "WOPI info for iOS app",
"type": "boolean"
},
"roleId": {
"description": "Highest role of the current user on this file",
"type": "string"
},
"isShared": {
"description": "Indicates whether the file is shared",
"type": "string"
},
"fingerprints": {
"description": "Array of file fingerprint objects",
"type": "array",
"items": {
"type": "string"
}
},
"tags": {
"description": "Array of tag objects",
"type": "array",
"items": {
"$ref": "#/components/schemas/Tag"
}
}
}
},
"DliFile.Post": {
"description": "Class DliFile",
"required": [
"name"
],
"properties": {
"addLinks": {
"description": "Indicates whether HATEOAS links should be included in the response",
"type": "boolean"
},
"name": {
"description": "Display name of the file",
"type": "string"
}
}
},
"DliFile.Put": {
"description": "Class DliFile",
"required": [
"name"
],
"properties": {
"addLinks": {
"description": "Indicates whether HATEOAS links should be included in the response",
"type": "boolean"
},
"name": {
"description": "Display name of the file",
"type": "string"
},
"expire": {
"description": "The file expiration date.",
"type": "string"
},
"replace": {
"description": "Replace the file if file with same name exists",
"type": "string"
}
}
},
"FileTypeGroup": {
"description": "Class MediaTypeGroup",
"properties": {
"id": {
"description": "Unique identifier of the file type group",
"type": "integer"
},
"name": {
"description": "Display name of the file type group",
"type": "string"
},
"links": {
"description": "HATEOAS links associated with the entity",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"FileTypeGroup.Post": {
"description": "Class MediaTypeGroup",
"properties": {
"addLinks": {
"description": "Indicates whether HATEOAS links should be included in the response",
"type": "boolean"
}
}
},
"FileTypeGroup.Put": {
"description": "Class MediaTypeGroup",
"properties": {
"addLinks": {
"description": "Indicates whether HATEOAS links should be included in the response",
"type": "boolean"
}
}
},
"MonthlyBandwidth": {
"description": "Class MonthlyBandwidth",
"properties": {
"dateTime": {
"description": "Bandwidth measurement date and time",
"type": "string",
"format": "date"
},
"eventStatus": {
"description": "Event status. Accepted values: `1` (upload), `2` (download)",
"type": "integer"
},
"usage": {
"description": "Bandwidth usage in bytes",
"type": "integer"
}
}
},
"ECPreviewStatus": {
"description": "Class ECPreviewStatus",
"required": [
"eCObjectUUId",
"transactionId"
],
"properties": {
"transactionId": {
"description": "Preview status transaction unique identifier",
"type": "string"
},
"eCObjectUUId": {
"description": "Repositories Gateway Object unique identifier",
"type": "string"
}
}
},
"Notification": {
"description": "Class Notification",
"required": [
"userId"
],
"properties": {
"userId": {
"description": "Unique identifier of the user who sends email notifications to recipients",
"type": "string"
},
"objectId": {
"description": "Unique identifier of the folder included in the notification",
"type": "integer"
},
"fileAdded": {
"description": "Number of files added to the notification",
"type": "integer"
},
"commentAdded": {
"description": "Number of comments added to the notification",
"type": "integer"
},
"links": {
"description": "HATEOAS links associated with the entity",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"Notification.Post": {
"description": "Class Notification",
"properties": {
"fileAdded": {
"description": "Number of files added to the notification",
"type": "integer"
},
"commentAdded": {
"description": "Number of comments added to the notification",
"type": "integer"
},
"addLinks": {
"description": "Indicates whether HATEOAS links should be included in the response",
"type": "boolean"
}
}
},
"Notification.Put": {
"description": "Class Notification",
"properties": {
"fileAdded": {
"description": "Number of files added to the notification",
"type": "integer"
},
"commentAdded": {
"description": "Number of comments added to the notification",
"type": "integer"
},
"addLinks": {
"description": "Indicates whether HATEOAS links should be included in the response",
"type": "boolean"
}
}
},
"CopyEcItemJob": {
"properties": {
"id": {
"description": "Job unique identifier",
"type": "string"
},
"status": {
"description": "Current job status. Accepted values: `queued`, `working`, `succeeded`, `failed`",
"type": "string"
},
"errors": {
"description": "List of errors that occurred during job processing",
"type": "string"
},
"objectIds": {
"description": "List of object IDs associated with this job",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"Recipient": {
"type": "object",
"properties": {
"userId": {
"type": "string",
"description": "Unique identifier of the user associated with the recipient."
},
"type": {
"type": "integer",
"description": "Recipient type.
`0` \u2013 To.
`1` \u2013 CC.
`2` \u2013 BCC."
},
"email": {
"type": "string",
"description": "Email address of the recipient."
},
"isDistributionList": {
"type": "boolean",
"description": "Indicates if the recipient is a distribution list rather than an individual user."
},
"user": {
"description": "Details of the user associated with the recipient.",
"allOf": [
{
"$ref": "#/components/schemas/UserBasic"
}
]
}
}
},
"Recipient.Post": {
"description": "Class Recipient",
"required": [
"userId"
],
"properties": {
"userId": {
"description": "Recipient user unique identifier",
"type": "integer"
},
"type": {
"description": "Recipient type. Accepted values: `0` (TO), `1` (CC), `2` (BCC)",
"type": "integer",
"enum": [
"0",
"1",
"2"
]
},
"read": {
"description": "Indicates whether the email has been read",
"type": "boolean"
},
"addLinks": {
"description": "Indicates whether HATEOAS links should be included in the response",
"type": "boolean"
}
}
},
"Recipient.Put": {
"description": "Class Recipient",
"required": [
"userId"
],
"properties": {
"userId": {
"description": "Recipient user unique identifier",
"type": "integer"
},
"addLinks": {
"description": "Indicates whether HATEOAS links should be included in the response",
"type": "boolean"
}
}
},
"ECUserSource": {
"description": "Class ECUserSource",
"required": [
"id",
"name",
"sourceId",
"userId"
],
"properties": {
"id": {
"description": "Repositories Gateway User Source unique identifier",
"type": "integer"
},
"name": {
"description": "Display name of the Repositories Gateway Source as configured by the user",
"type": "string"
},
"userId": {
"description": "The unique identifier of the user.",
"type": "string"
},
"sourceId": {
"description": "Repositories Gateway Source unique identifier",
"type": "integer"
}
}
},
"Role": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "Role ID"
},
"name": {
"type": "string",
"description": "Role name"
},
"rank": {
"type": "integer",
"description": "Role rank"
},
"type": {
"type": "string",
"description": "Role type"
}
}
},
"Role.Post": {
"description": "Class Role",
"properties": {
"addLinks": {
"description": "Indicates whether HATEOAS links should be included in the response",
"type": "boolean"
}
}
},
"Role.Put": {
"description": "Class Role",
"properties": {
"addLinks": {
"description": "Indicates whether HATEOAS links should be included in the response",
"type": "boolean"
}
}
},
"SourceFolder": {
"required": [
"id",
"name",
"parentId",
"type",
"wopiapp"
],
"properties": {
"id": {
"description": "Unique SourceContent identifier",
"type": "string"
},
"name": {
"description": "Display name of the source content item",
"type": "string"
},
"parentId": {
"description": "Parent source content unique identifier",
"type": "string"
},
"type": {
"description": "Source content type. Accepted values: \\`d\\` (folder), \\`f\\` (file)",
"type": "string"
},
"created": {
"description": "Creation timestamp of the source content in UTC",
"type": "string",
"format": "date"
},
"modified": {
"description": "Last modification timestamp of the source content in UTC",
"type": "string",
"format": "date"
},
"status": {
"description": "Current availability status of the source content item",
"type": "string"
},
"deleted": {
"description": "Indicates whether the source content is deleted",
"type": "boolean"
},
"path": {
"description": "Full path of the source content",
"type": "string"
},
"userRoleId": {
"description": "Current user role id (Explicit field. May be retrieved only if mentioned in \"with\" parameter)",
"type": "integer"
},
"creator": {
"description": "File's creator (Explicit field. May be retrieved only if mentioned in \"with\" parameter)",
"$ref": "#/components/schemas/UserBasicInfo"
},
"permissions": {
"description": "Current user's permissions (Explicit field. May be retrieved only if mentioned in \"with\" parameter)",
"type": "array",
"items": {
"$ref": "#/components/schemas/Permission"
}
},
"wopiapp": {
"description": "WOPI info for iOS app",
"type": "boolean"
},
"rootId": {
"description": "Unique identifier of the root-level source content ancestor (Explicit field. May be retrieved only if mentioned in \"with\" parameter)",
"type": "string"
},
"pathIds": {
"description": "Ordered list of ancestor identifiers representing the full path from root to this source content item (Explicit field. May be retrieved only if mentioned in \"with\" parameter)",
"type": "string"
},
"sourceTypeId": {
"description": "Unique identifier of the ECM source type this content belongs to (Explicit field. May be retrieved only if mentioned in \"with\" parameter)",
"type": "string"
},
"totalFilesCount": {
"description": "Total number of files in the source content (Explicit field. May be retrieved only if mentioned in \"with\" parameter)",
"type": "string"
},
"totalFoldersCount": {
"description": "Total number of folders in the source content (Explicit field. May be retrieved only if mentioned in \"with\" parameter)",
"type": "string"
},
"parent": {
"description": "Parent source content item (Explicit field. May be retrieved only if mentioned in \"with\" parameter)",
"$ref": "#/components/schemas/SourceContent"
},
"links": {
"description": "HATEOAS links associated with the entity",
"type": "array",
"items": {
"type": "string"
}
},
"isFavorite": {
"description": "Indicates that Folder is marked as favorite for current user",
"type": "boolean"
}
}
},
"SourceFolder.Post": {
"properties": {
"id": {
"description": "Unique SourceContent identifier",
"type": "string"
},
"addLinks": {
"description": "Indicates whether HATEOAS links should be included in the response",
"type": "boolean"
}
}
},
"SourceFolder.Put": {
"properties": {
"id": {
"description": "Unique SourceContent identifier",
"type": "string"
},
"addLinks": {
"description": "Indicates whether HATEOAS links should be included in the response",
"type": "boolean"
}
}
},
"Transaction": {
"description": "Class Transaction",
"required": [
"accessToken",
"id"
],
"properties": {
"id": {
"description": "Unique transaction identifier",
"type": "string"
},
"accessToken": {
"description": "Bearer token used to authenticate requests within this transaction",
"type": "string"
},
"links": {
"description": "HATEOAS links associated with the entity",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"Transaction.Post": {
"description": "Class Transaction",
"required": [
"id",
"accessToken"
],
"properties": {
"id": {
"description": "Unique transaction identifier",
"type": "string"
},
"accessToken": {
"description": "Bearer token used to authenticate requests within this transaction",
"type": "string"
},
"addLinks": {
"description": "Indicates whether HATEOAS links should be included in the response",
"type": "boolean"
}
}
},
"Transaction.Put": {
"description": "Class Transaction",
"properties": {
"addLinks": {
"description": "Indicates whether HATEOAS links should be included in the response",
"type": "boolean"
}
}
},
"UserOtpAuth.Post": {
"description": "Class UserOtpAuth",
"required": [
"username",
"otp",
"referral"
],
"properties": {
"username": {
"description": "The unique identifier of the user.",
"type": "string"
},
"otp": {
"description": "user otp",
"type": "string"
},
"referral": {
"description": "referral",
"type": "string"
}
}
},
"UserOtpAuth.Put": {
"description": "Class UserOtpAuth",
"required": [
"username",
"otp",
"referral"
],
"properties": {
"username": {
"description": "The unique identifier of the user.",
"type": "string"
},
"otp": {
"description": "user otp",
"type": "string"
},
"referral": {
"description": "referral",
"type": "string"
}
}
},
"TokenExchange.Post": {
"description": "Class TokenExchange",
"required": [
"clientId"
],
"properties": {
"clientId": {
"description": "client id",
"type": "string"
}
}
},
"TokenExchange.Put": {
"description": "Class TokenExchange",
"required": [
"clientId"
],
"properties": {
"clientId": {
"description": "client id",
"type": "string"
}
}
},
"MemberBulk.Post": {
"description": "Class MemberBulk",
"required": [
"roleId"
],
"properties": {
"notify": {
"description": "Indicates whether user would like to receive emails when new member is added into folder",
"type": "boolean",
"default": true
},
"emails": {
"description": "Member emails",
"type": "array",
"items": {
"type": "string"
}
},
"userIds": {
"description": "User Ids",
"type": "array",
"items": {
"type": "string"
}
},
"ldapGroupIds": {
"description": "Member group ids",
"type": "array",
"items": {
"type": "string"
}
},
"roleId": {
"description": "Role id",
"type": "integer"
},
"notifyFileAdded": {
"type": "boolean"
}
}
},
"MemberBulk.Put": {
"description": "Class MemberBulk",
"required": [
"roleId"
],
"properties": {
"notify": {
"description": "Indicates whether user would like to receive emails when new member is added into folder",
"type": "boolean",
"default": true
},
"emails": {
"description": "Member emails",
"type": "array",
"items": {
"type": "string"
}
},
"userIds": {
"description": "User Ids",
"type": "array",
"items": {
"type": "string"
}
},
"ldapGroupIds": {
"description": "Member group ids",
"type": "array",
"items": {
"type": "string"
}
},
"roleId": {
"description": "Role id",
"type": "integer"
},
"notifyFileAdded": {
"type": "boolean"
}
}
},
"UserDemoteToRecipient.Post": {
"description": "Class UserDemoteToRecipient",
"properties": {
"remoteWipe": {
"description": "Indicates whether to remotely wipe data from both desktop and mobile devices.",
"type": "boolean"
},
"deleteUnsharedData": {
"description": "Indicates whether data owned by the user should be deleted. This is required and must be set to True if `retainData` is False, and vice versa.",
"type": "boolean"
},
"retainData": {
"description": "Indicates whether data should be retained and transferred to another user. This is required and must be True if `deleteUnsharedData` is False, and vice versa.",
"type": "boolean"
},
"retainToUser": {
"description": "The ID of the new owner to whom the data will be transferred, applicable when `retainData` and/or `retainPermissionToSharedData` are set to true.",
"type": "string"
},
"retainToAdvancedFormUser": {
"description": "The ID of the user to whom the advanced form data will be transferred, similar to retainToUser but specifically for advanced form components.",
"type": "string"
},
"retainPermissionToSharedData": {
"description": "Indicates whether permissions to shared folder should be retained.",
"type": "boolean"
},
"withdrawRequestFiles": {
"description": "Indicates whether request files should be withdrawn.",
"type": "boolean"
},
"withdrawFileLinks": {
"description": "Indicates whether sent files should be withdrawn.",
"type": "boolean"
}
}
},
"UserDemoteToRecipient.Put": {
"description": "Class UserDemoteToRecipient",
"properties": {
"remoteWipe": {
"description": "Indicates whether to remotely wipe data from both desktop and mobile devices.",
"type": "boolean"
},
"deleteUnsharedData": {
"description": "Indicates whether data owned by the user should be deleted. This is required and must be set to True if `retainData` is False, and vice versa.",
"type": "boolean"
},
"retainData": {
"description": "Indicates whether data should be retained and transferred to another user. This is required and must be True if `deleteUnsharedData` is False, and vice versa.",
"type": "boolean"
},
"retainToUser": {
"description": "The ID of the new owner to whom the data will be transferred, applicable when `retainData` and/or `retainPermissionToSharedData` are set to true.",
"type": "string"
},
"retainToAdvancedFormUser": {
"description": "The ID of the user to whom the advanced form data will be transferred, similar to retainToUser but specifically for advanced form components.",
"type": "string"
},
"retainPermissionToSharedData": {
"description": "Indicates whether permissions to shared folder should be retained.",
"type": "boolean"
},
"withdrawRequestFiles": {
"description": "Indicates whether request files should be withdrawn.",
"type": "boolean"
},
"withdrawFileLinks": {
"description": "Indicates whether sent files should be withdrawn.",
"type": "boolean"
}
}
},
"FilePermissions": {
"description": "Class FilePermissions",
"properties": {
"fileId": {
"description": "Id of file",
"type": "string"
},
"permissions": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"FilePermissions.Post": {
"description": "Class FilePermissions",
"properties": {
"fileId": {
"description": "Id of file",
"type": "integer"
},
"fileGuid": {
"description": "Guid of file",
"type": "string"
},
"permissions": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"FilePermissions.Put": {
"description": "Class FilePermissions",
"properties": {
"fileId": {
"description": "Id of file",
"type": "integer"
},
"fileGuid": {
"description": "Guid of file",
"type": "string"
},
"permissions": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"FolderMove.Post": {
"description": "Class FolderMove",
"required": [
"destinationFolderId"
],
"properties": {
"destinationFolderId": {
"description": "Destination Folder unique identifier",
"type": "string"
}
}
},
"FolderMove.Put": {
"description": "Class FolderMove",
"required": [
"destinationFolderId"
],
"properties": {
"destinationFolderId": {
"description": "Destination Folder unique identifier",
"type": "string"
}
}
},
"ProfileMapping": {
"description": "Class ProfileMapping",
"required": [
"impact"
],
"properties": {
"impact": {
"description": "Get the User Profile mapping order",
"type": "array",
"items": {
"type": "string"
}
},
"id": {
"description": "Get the id of the target authentication source",
"type": "string"
},
"name": {
"description": "Get the name of the target authentication source",
"type": "string"
},
"filter": {
"description": "Get the filter of the target authentication source",
"type": "string"
}
}
},
"ProfileMapping.Post": {
"description": "Class ProfileMapping",
"required": [
"id"
],
"properties": {
"peek": {
"description": "Set if we are peeking into the impact",
"type": "boolean"
},
"id": {
"description": "Specify the id of the target authentication source",
"type": "string"
},
"filter": {
"description": "Set the filter of the target authentication source",
"type": "string"
}
}
},
"ProfileMapping.Put": {
"description": "Class ProfileMapping",
"required": [
"id"
],
"properties": {
"peek": {
"description": "Set if we are peeking into the impact",
"type": "boolean"
},
"id": {
"description": "Specify the id of the target authentication source",
"type": "string"
},
"filter": {
"description": "Set the filter of the target authentication source",
"type": "string"
}
}
},
"UserResetPassword.Post": {
"description": "Class UserResetPassword",
"required": [
"link",
"password"
],
"properties": {
"link": {
"description": "The password reset link",
"type": "string"
},
"password": {
"description": "Password",
"type": "string"
}
}
},
"UserResetPassword.Put": {
"description": "Class UserResetPassword",
"required": [
"link",
"password"
],
"properties": {
"link": {
"description": "The password reset link",
"type": "string"
},
"password": {
"description": "Password",
"type": "string"
}
}
},
"SearchMetadata": {
"properties": {
"total": {
"description": "Total items count",
"type": "integer"
},
"totalFilesCount": {
"description": "Total files count",
"type": "integer"
},
"totalFoldersCount": {
"description": "Total folders count",
"type": "integer"
},
"totalEmailsCount": {
"description": "Total emails count",
"type": "integer"
}
}
},
"UserMobileNumberPassword.Post": {
"description": "Class UserPassword",
"required": [
"password",
"mobileNumber"
],
"properties": {
"password": {
"description": "The current password of the user",
"type": "string"
},
"mobileNumber": {
"description": "The user's new mobile number",
"type": "string"
},
"testOnly": {
"description": "If true, a short message will be sent to the number, and the number will not be saved",
"type": "boolean"
}
}
},
"UserMobileNumberPassword.Put": {
"description": "Class UserPassword",
"required": [
"password",
"mobileNumber"
],
"properties": {
"password": {
"description": "The current password of the user",
"type": "string"
},
"mobileNumber": {
"description": "The user's new mobile number",
"type": "string"
},
"testOnly": {
"description": "If true, a short message will be sent to the number, and the number will not be saved",
"type": "boolean"
}
}
},
"FileZip.Post": {
"description": "Class FileZip",
"properties": {
"fileIds": {
"description": "List of file IDs",
"type": "array",
"items": {
"type": "string"
}
},
"folderIds": {
"description": "List of folder IDs",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"FileZip.Put": {
"description": "Class FileZip",
"properties": {
"fileIds": {
"description": "List of file IDs",
"type": "array",
"items": {
"type": "string"
}
},
"folderIds": {
"description": "List of folder IDs",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"FolderCreate.Post": {
"description": "Class FolderCreate",
"required": [
"name"
],
"properties": {
"name": {
"description": "Folder name",
"type": "string"
},
"secure": {
"description": "Indicates whether folder is secure.\n * Only top level folders under user's root folder can be set to secure",
"type": "boolean"
},
"isSalesforceRoot": {
"description": "",
"type": "boolean"
},
"systemFolder": {
"type": "integer"
},
"syncable": {
"description": "Indicates that folder is syncable. Can only be set at a top level folder.",
"type": "boolean"
},
"expire": {
"description": "The folder expiration date. Applicable to top level folders",
"type": "string",
"format": "date"
},
"fileLifetime": {
"description": "The file's lifetime in the folder",
"type": "integer"
},
"description": {
"description": "Folder description",
"type": "string"
},
"isFolderUpload": {
"description": "Indicate whether is folder upload children (for internal use only)",
"type": "boolean"
}
}
},
"FolderCreate.Put": {
"description": "Class FolderCreate",
"required": [
"name"
],
"properties": {
"name": {
"description": "Folder name",
"type": "string"
},
"secure": {
"description": "Indicates whether folder is secure.\n * Only top level folders under user's root folder can be set to secure",
"type": "boolean"
},
"isSalesforceRoot": {
"description": "",
"type": "boolean"
},
"systemFolder": {
"type": "integer"
},
"syncable": {
"description": "Indicates that folder is syncable. Can only be set at a top level folder.",
"type": "boolean"
},
"expire": {
"description": "The folder expiration date. Applicable to top level folders",
"type": "string",
"format": "date"
},
"fileLifetime": {
"description": "The file's lifetime in the folder",
"type": "integer"
},
"description": {
"description": "Folder description",
"type": "string"
},
"isFolderUpload": {
"description": "Indicate whether is folder upload children (for internal use only)",
"type": "boolean"
}
}
},
"OtpRecipientChanges": {
"description": "Class ProfileMappingChanges",
"required": [
"recipients"
],
"properties": {
"recipients": {
"description": "Get list of recipient, mobile number value pairs",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"OtpRecipientChanges.Post": {
"description": "Class ProfileMappingChanges",
"properties": {
"recipients": {
"description": "Set list of otp recipient changes",
"type": "array",
"items": {
"$ref": "#/components/schemas/OtpRecipientModel"
}
}
}
},
"OtpRecipientChanges.Put": {
"description": "Class ProfileMappingChanges",
"properties": {
"recipients": {
"description": "Set list of otp recipient changes",
"type": "array",
"items": {
"$ref": "#/components/schemas/OtpRecipientModel"
}
}
}
},
"UserTfa.Post": {
"description": "Class UserTfa",
"required": [
"otp"
],
"properties": {
"otp": {
"description": "OTP",
"type": "string"
},
"referral": {
"description": "referral",
"type": "string"
},
"rememberDevice": {
"description": "remember device",
"type": "boolean"
}
}
},
"UserTfa.Put": {
"description": "Class UserTfa",
"required": [
"otp"
],
"properties": {
"otp": {
"description": "OTP",
"type": "string"
},
"referral": {
"description": "referral",
"type": "string"
},
"rememberDevice": {
"description": "remember device",
"type": "boolean"
}
}
},
"RemoteWipe.Post": {
"description": "Class RemoteWipe",
"properties": {
"userId": {
"description": "Unique identifier of user",
"type": "integer"
},
"clientId": {
"description": "Unique identifier of client",
"type": "string"
},
"installTagId": {
"description": "Unique identifier of install tag",
"type": "string"
}
}
},
"RemoteWipe.Put": {
"description": "Class RemoteWipe",
"properties": {
"userId": {
"description": "Unique identifier of user",
"type": "integer"
},
"clientId": {
"description": "Unique identifier of client",
"type": "string"
},
"installTagId": {
"description": "Unique identifier of install tag",
"type": "string"
}
}
},
"UsersEmailMigration.Post": {
"description": "Class UsersEmailMigration",
"properties": {
"users": {
"description": "Array of user objects, each containing old and new email values.",
"type": "array",
"items": {
"$ref": "#/components/schemas/UserEmail.Post"
}
},
"deleteIfExists": {
"description": "Indicates whether to delete users whose emails match any in the newEmail field.",
"type": "boolean"
}
}
},
"UsersEmailMigration.Put": {
"description": "Class UsersEmailMigration",
"properties": {
"users": {
"description": "Array of user objects, each containing old and new email values.",
"type": "array",
"items": {
"$ref": "#/components/schemas/UserEmail.Post"
}
},
"deleteIfExists": {
"description": "Indicates whether to delete users whose emails match any in the newEmail field.",
"type": "boolean"
}
}
},
"UserForcedPasswordChange.Post": {
"description": "Class UserForcedPasswordChange",
"properties": {
"password": {
"description": "The user's password",
"type": "string"
},
"previousPassword": {
"description": "The user's previous password",
"type": "string"
},
"referral": {
"description": "referral",
"type": "string"
}
}
},
"UserForcedPasswordChange.Put": {
"description": "Class UserForcedPasswordChange",
"properties": {
"password": {
"description": "The user's password",
"type": "string"
},
"previousPassword": {
"description": "The user's previous password",
"type": "string"
},
"referral": {
"description": "referral",
"type": "string"
}
}
},
"ProfileMappingChanges": {
"description": "Class ProfileMappingChanges",
"required": [
"impact"
],
"properties": {
"impact": {
"description": "Get the User Profile mapping order",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"ProfileMappingChanges.Post": {
"description": "Class ProfileMappingChanges",
"properties": {
"peek": {
"description": "Set if we are peeking into the impact",
"type": "boolean"
},
"changes": {
"description": "policy changes to be tested/applied",
"type": "array",
"items": {
"$ref": "#/components/schemas/ProfileMapping"
}
}
}
},
"ProfileMappingChanges.Put": {
"description": "Class ProfileMappingChanges",
"properties": {
"peek": {
"description": "Set if we are peeking into the impact",
"type": "boolean"
},
"changes": {
"description": "policy changes to be tested/applied",
"type": "array",
"items": {
"$ref": "#/components/schemas/ProfileMapping"
}
}
}
},
"EncryptUsername.Post": {
"description": "Class EncryptUsername",
"required": [
"username",
"clientId",
"clientSecret"
],
"properties": {
"username": {
"description": "username",
"type": "string"
},
"clientId": {
"description": "client id",
"type": "string"
},
"clientSecret": {
"description": "client secret",
"type": "string"
}
}
},
"EncryptUsername.Put": {
"description": "Class EncryptUsername",
"required": [
"username",
"clientId",
"clientSecret"
],
"properties": {
"username": {
"description": "username",
"type": "string"
},
"clientId": {
"description": "client id",
"type": "string"
},
"clientSecret": {
"description": "client secret",
"type": "string"
}
}
},
"UserPreauth.Post": {
"description": "Class UserPreauth",
"required": [
"username"
],
"properties": {
"username": {
"description": "username",
"type": "string"
},
"referral": {
"description": "referral",
"type": "string"
}
}
},
"UserPreauth.Put": {
"description": "Class UserPreauth",
"required": [
"username"
],
"properties": {
"username": {
"description": "username",
"type": "string"
},
"referral": {
"description": "referral",
"type": "string"
}
}
},
"UserTfaTotpVerifySecret.Post": {
"description": "Class UserTfaTotpVerifySecret",
"required": [
"otp"
],
"properties": {
"otp": {
"description": "OTP",
"type": "string"
},
"referral": {
"description": "referral",
"type": "string"
}
}
},
"UserTfaTotpVerifySecret.Put": {
"description": "Class UserTfaTotpVerifySecret",
"required": [
"otp"
],
"properties": {
"otp": {
"description": "OTP",
"type": "string"
},
"referral": {
"description": "referral",
"type": "string"
}
}
},
"EmailCounters": {
"description": "Class EmailCounters",
"properties": {
"draft": {
"description": "Number of emails in 'draft' bucket",
"type": "integer"
},
"outgoing": {
"description": "Number of emails in 'outgoing' bucket",
"type": "integer"
},
"outgoingTransferring": {
"description": "Number of emails in 'outgoing' bucket in transferring state",
"type": "integer"
},
"outgoingTransferringIds": {
"description": "Number of emails in 'outgoing' bucket in transferring state",
"type": "array",
"items": {
"type": "string"
}
},
"outgoingQueued": {
"description": "Number of emails in 'outgoing' bucket in queued state",
"type": "integer"
},
"outgoingError": {
"description": "Number of emails in 'outgoing' bucket in error state",
"type": "integer"
},
"inboxUnread": {
"description": "Number of unread emails in 'inbox' bucket",
"type": "integer"
},
"trash": {
"description": "Number of emails in 'trash' bucket",
"type": "integer"
}
}
},
"AdminRoleGroupPolicyChanges.Post": {
"description": "Class AdminRoleGroupPolicyChanges",
"properties": {
"changes": {
"description": "policy changes to be applied",
"type": "array",
"items": {
"$ref": "#/components/schemas/AdminRoleGroupPolicy"
}
}
}
},
"AdminRoleGroupPolicyChanges.Put": {
"description": "Class AdminRoleGroupPolicyChanges",
"properties": {
"changes": {
"description": "policy changes to be applied",
"type": "array",
"items": {
"$ref": "#/components/schemas/AdminRoleGroupPolicy"
}
}
}
},
"LdapSearchResultUser": {
"description": "Class LdapSearchResultUser",
"properties": {
"email": {
"description": "User's email",
"type": "string"
},
"displayName": {
"description": "Users's display name",
"type": "string"
}
}
},
"ProfileMappings": {
"description": "Class ProfileMappings",
"properties": {
"ldap": {
"description": "Get the ldap policy filters for the user profile",
"type": "array",
"items": {
"$ref": "#/components/schemas/ProfileMapping"
}
},
"kiteworks": {
"description": "Get the kiteworks policy filters for the user profile",
"type": "array",
"items": {
"$ref": "#/components/schemas/ProfileMapping"
}
},
"sso": {
"description": "Get the ldap policy filters for the user profile",
"type": "array",
"items": {
"$ref": "#/components/schemas/ProfileMapping"
}
}
}
},
"UserDemoteToRestricted.Post": {
"description": "Class UserDemoteToRestricted",
"properties": {
"remoteWipe": {
"description": "Indicates whether to remotely wipe data from both desktop and mobile devices.",
"type": "boolean"
},
"deleteUnsharedData": {
"description": "Indicates whether data owned by the user should be deleted. This is required and must be set to True if `retainData` is False, and vice versa.",
"type": "boolean"
},
"retainData": {
"description": "Indicates whether data should be retained and transferred to another user. This is required and must be True if `deleteUnsharedData` is False, and vice versa.",
"type": "boolean"
},
"retainToUser": {
"description": "The ID of the new owner to whom the data will be transferred, applicable when `retainData` and/or `retainPermissionToSharedData` are set to true.",
"type": "string"
},
"retainToAdvancedFormUser": {
"description": "The ID of the user to whom the advanced form data will be transferred, similar to retainToUser but specifically for advanced form components.",
"type": "string"
},
"retainPermissionToSharedData": {
"description": "Indicates whether permissions to shared folder should be retained.",
"type": "boolean"
},
"withdrawRequestFiles": {
"description": "Indicates whether request files should be withdrawn.",
"type": "boolean"
},
"withdrawFileLinks": {
"description": "Indicates whether sent files should be withdrawn.",
"type": "boolean"
}
}
},
"UserDemoteToRestricted.Put": {
"description": "Class UserDemoteToRestricted",
"properties": {
"remoteWipe": {
"description": "Indicates whether to remotely wipe data from both desktop and mobile devices.",
"type": "boolean"
},
"deleteUnsharedData": {
"description": "Indicates whether data owned by the user should be deleted. This is required and must be set to True if `retainData` is False, and vice versa.",
"type": "boolean"
},
"retainData": {
"description": "Indicates whether data should be retained and transferred to another user. This is required and must be True if `deleteUnsharedData` is False, and vice versa.",
"type": "boolean"
},
"retainToUser": {
"description": "The ID of the new owner to whom the data will be transferred, applicable when `retainData` and/or `retainPermissionToSharedData` are set to true.",
"type": "string"
},
"retainToAdvancedFormUser": {
"description": "The ID of the user to whom the advanced form data will be transferred, similar to retainToUser but specifically for advanced form components.",
"type": "string"
},
"retainPermissionToSharedData": {
"description": "Indicates whether permissions to shared folder should be retained.",
"type": "boolean"
},
"withdrawRequestFiles": {
"description": "Indicates whether request files should be withdrawn.",
"type": "boolean"
},
"withdrawFileLinks": {
"description": "Indicates whether sent files should be withdrawn.",
"type": "boolean"
}
}
},
"MigrateUsersCsv.Post": {
"description": "Class MigrateUsersCsv",
"properties": {
"deleteIfExists": {
"description": "Indicates whether to delete users whose emails match any in the newEmail field.",
"type": "boolean"
}
}
},
"MigrateUsersCsv.Put": {
"description": "Class MigrateUsersCsv",
"properties": {
"deleteIfExists": {
"description": "Indicates whether to delete users whose emails match any in the newEmail field.",
"type": "boolean"
}
}
},
"LdapSearchResults": {
"description": "Class LdapSearchResults",
"required": [
"matches"
],
"properties": {
"matches": {
"description": "Search matches",
"type": "array",
"items": {
"$ref": "#/components/schemas/LdapSearchResultUser"
}
}
}
},
"ActivationCodeSend.Post": {
"description": "Class ActivationCodeSend",
"required": [
"email",
"referral"
],
"properties": {
"email": {
"description": "email",
"type": "string"
},
"referral": {
"description": "referral",
"type": "string"
},
"resend": {
"description": "resend",
"type": "string"
}
}
},
"ActivationCodeSend.Put": {
"description": "Class ActivationCodeSend",
"required": [
"email",
"referral"
],
"properties": {
"email": {
"description": "email",
"type": "string"
},
"referral": {
"description": "referral",
"type": "string"
},
"resend": {
"description": "resend",
"type": "string"
}
}
},
"UserPassword.Post": {
"description": "Class UserPassword",
"properties": {
"password": {
"description": "The user's password",
"type": "string"
},
"previousPassword": {
"description": "The user's previous password",
"type": "string"
}
}
},
"UserPassword.Put": {
"description": "Class UserPassword",
"properties": {
"password": {
"description": "The user's password",
"type": "string"
},
"previousPassword": {
"description": "The user's previous password",
"type": "string"
}
}
},
"Sendfile.Post": {
"description": "Class Sendfile",
"properties": {
"to": {
"type": "array",
"items": {
"type": "string"
}
},
"cc": {
"type": "array",
"items": {
"type": "string"
}
},
"bcc": {
"type": "array",
"items": {
"type": "string"
}
},
"files": {
"type": "array",
"items": {
"type": "string"
}
},
"acl": {
"type": "string",
"enum": [
"verify_recipient",
"no_auth",
"otp",
"internal",
"anyone_auth",
"email_otp"
]
},
"expire": {
"type": "string",
"format": "date-time"
},
"draft": {
"type": "boolean"
},
"preview": {
"description": "Indicates that email is a preview email",
"type": "boolean"
},
"watermark": {
"description": "The watermark on the preview email",
"type": "string"
},
"secureBody": {
"type": "boolean"
},
"selfCopy": {
"type": "boolean"
},
"includeFingerprint": {
"type": "boolean"
},
"parentEmailId": {
"type": "integer"
},
"isSelfReturnReceipt": {
"type": "boolean"
},
"returnReceipts": {
"type": "array",
"items": {
"type": "string"
}
},
"type": {
"description": "Email type",
"type": "string",
"enum": [
"original",
"resend",
"forward",
"reply"
]
},
"uploading": {
"description": "Indicates whether upload is still in progress. Prevents sending if is set to true.",
"type": "boolean"
},
"body": {
"type": "string"
},
"subject": {
"type": "string"
},
"webFormId": {
"type": "string"
},
"webFormFields": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"Sendfile.Put": {
"description": "Class Sendfile",
"properties": {
"to": {
"type": "array",
"items": {
"type": "string"
}
},
"cc": {
"type": "array",
"items": {
"type": "string"
}
},
"bcc": {
"type": "array",
"items": {
"type": "string"
}
},
"files": {
"type": "array",
"items": {
"type": "string"
}
},
"updateFid": {
"type": "array",
"items": {
"type": "string"
}
},
"acl": {
"type": "string",
"enum": [
"verify_recipient",
"no_auth",
"otp",
"internal",
"anyone_auth",
"email_otp"
]
},
"expire": {
"type": "string",
"format": "date-time"
},
"draft": {
"type": "boolean"
},
"preview": {
"description": "Indicates that email is a preview email",
"type": "boolean"
},
"watermark": {
"description": "The watermark on the preview email",
"type": "string"
},
"secureBody": {
"type": "boolean"
},
"selfCopy": {
"type": "boolean"
},
"includeFingerprint": {
"type": "boolean"
},
"isSelfReturnReceipt": {
"type": "boolean"
},
"returnReceipts": {
"type": "array",
"items": {
"type": "string"
}
},
"uploading": {
"description": "Indicates whether upload is still in progress. Prevents sending if is set to true.",
"type": "boolean"
},
"body": {
"type": "string"
},
"subject": {
"type": "string"
},
"webFormId": {
"type": "string"
},
"webFormFields": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"UserDemoteOptions.Post": {
"description": "Class UserDemoteOptions",
"properties": {
"remoteWipe": {
"description": "Indicates whether to remotely wipe data from both desktop and mobile devices.",
"type": "boolean"
},
"deleteUnsharedData": {
"description": "Indicates whether data owned by the user should be deleted. This is required and must be set to True if `retainData` is False, and vice versa.",
"type": "boolean"
},
"retainData": {
"description": "Indicates whether data should be retained and transferred to another user. This is required and must be True if `deleteUnsharedData` is False, and vice versa.",
"type": "boolean"
},
"retainToUser": {
"description": "The ID of the new owner to whom the data will be transferred, applicable when `retainData` and/or `retainPermissionToSharedData` are set to true.",
"type": "string"
},
"retainToAdvancedFormUser": {
"description": "The ID of the user to whom the advanced form data will be transferred, similar to retainToUser but specifically for advanced form components.",
"type": "string"
},
"retainPermissionToSharedData": {
"description": "Indicates whether permissions to shared folder should be retained.",
"type": "boolean"
},
"withdrawRequestFiles": {
"description": "Indicates whether request files should be withdrawn.",
"type": "boolean"
},
"withdrawFileLinks": {
"description": "Indicates whether sent files should be withdrawn.",
"type": "boolean"
}
}
},
"UserDemoteOptions.Put": {
"description": "Class UserDemoteOptions",
"properties": {
"remoteWipe": {
"description": "Indicates whether to remotely wipe data from both desktop and mobile devices.",
"type": "boolean"
},
"deleteUnsharedData": {
"description": "Indicates whether data owned by the user should be deleted. This is required and must be set to True if `retainData` is False, and vice versa.",
"type": "boolean"
},
"retainData": {
"description": "Indicates whether data should be retained and transferred to another user. This is required and must be True if `deleteUnsharedData` is False, and vice versa.",
"type": "boolean"
},
"retainToUser": {
"description": "The ID of the new owner to whom the data will be transferred, applicable when `retainData` and/or `retainPermissionToSharedData` are set to true.",
"type": "string"
},
"retainToAdvancedFormUser": {
"description": "The ID of the user to whom the advanced form data will be transferred, similar to retainToUser but specifically for advanced form components.",
"type": "string"
},
"retainPermissionToSharedData": {
"description": "Indicates whether permissions to shared folder should be retained.",
"type": "boolean"
},
"withdrawRequestFiles": {
"description": "Indicates whether request files should be withdrawn.",
"type": "boolean"
},
"withdrawFileLinks": {
"description": "Indicates whether sent files should be withdrawn.",
"type": "boolean"
}
}
},
"UserNamePassword.Post": {
"description": "Class UserNamePassword",
"properties": {
"password": {
"description": "The user's password",
"type": "string"
},
"previousPassword": {
"description": "The user's previous password",
"type": "string"
},
"name": {
"description": "The user's name",
"type": "string"
}
}
},
"UserNamePassword.Put": {
"description": "Class UserNamePassword",
"properties": {
"password": {
"description": "The user's password",
"type": "string"
},
"previousPassword": {
"description": "The user's previous password",
"type": "string"
},
"name": {
"description": "The user's name",
"type": "string"
}
}
},
"RequestFilePermission": {
"properties": {
"name": {
"description": "Action name",
"type": "string"
},
"enabled": {
"description": "Determines if action is valid",
"type": "boolean"
}
}
},
"UserAuthCode.Post": {
"description": "Class UserAuthCode",
"required": [
"childClientId"
],
"properties": {
"childClientId": {
"description": "Client id of the child client",
"type": "string"
}
}
},
"UserAuthCode.Put": {
"description": "Class UserAuthCode",
"required": [
"childClientId"
],
"properties": {
"childClientId": {
"description": "Client id of the child client",
"type": "string"
}
}
},
"OtpRecipientModel": {
"description": "Class ProfileMapping",
"properties": {
"userId": {
"description": "The otp recipient email",
"type": "integer"
},
"mobileNumber": {
"description": "Get the mobile number of the otp recipient",
"type": "string"
}
}
},
"OtpRecipientModel.Post": {
"description": "Class ProfileMapping",
"required": [
"userId",
"mobileNumber"
],
"properties": {
"userId": {
"description": "Specify the otp recipient's user id",
"type": "integer"
},
"mobileNumber": {
"description": "Set the filter of the target authentication source",
"type": "string"
}
}
},
"OtpRecipientModel.Put": {
"description": "Class ProfileMapping",
"required": [
"userId",
"mobileNumber"
],
"properties": {
"userId": {
"description": "Specify the otp recipient's user id",
"type": "integer"
},
"mobileNumber": {
"description": "Set the filter of the target authentication source",
"type": "string"
}
}
},
"UserDeleteOptions.Post": {
"description": "Class UserDeleteOptions",
"properties": {
"remoteWipe": {
"description": "Indicates whether to remotely wipe data from both desktop and mobile devices.",
"type": "boolean"
},
"deleteUnsharedData": {
"description": "Indicates whether data owned by the user should be deleted. This is required and must be set to True if `retainData` is False, and vice versa.",
"type": "boolean"
},
"retainData": {
"description": "Indicates whether data should be retained and transferred to another user. This is required and must be True if `deleteUnsharedData` is False, and vice versa.",
"type": "boolean"
},
"retainToUser": {
"description": "The ID of the new owner to whom the data will be transferred, applicable when `retainData` and/or `retainPermissionToSharedData` are set to true.",
"type": "string"
},
"retainToAdvancedFormUser": {
"description": "The ID of the user to whom the advanced form data will be transferred, similar to retainToUser but specifically for advanced form components.",
"type": "string"
},
"retainPermissionToSharedData": {
"description": "Indicates whether permissions to shared folder should be retained.",
"type": "boolean"
},
"withdrawRequestFiles": {
"description": "Indicates whether request files should be withdrawn.",
"type": "boolean"
},
"withdrawFileLinks": {
"description": "Indicates whether sent files should be withdrawn.",
"type": "boolean"
}
}
},
"UserDeleteOptions.Put": {
"description": "Class UserDeleteOptions",
"properties": {
"remoteWipe": {
"description": "Indicates whether to remotely wipe data from both desktop and mobile devices.",
"type": "boolean"
},
"deleteUnsharedData": {
"description": "Indicates whether data owned by the user should be deleted. This is required and must be set to True if `retainData` is False, and vice versa.",
"type": "boolean"
},
"retainData": {
"description": "Indicates whether data should be retained and transferred to another user. This is required and must be True if `deleteUnsharedData` is False, and vice versa.",
"type": "boolean"
},
"retainToUser": {
"description": "The ID of the new owner to whom the data will be transferred, applicable when `retainData` and/or `retainPermissionToSharedData` are set to true.",
"type": "string"
},
"retainToAdvancedFormUser": {
"description": "The ID of the user to whom the advanced form data will be transferred, similar to retainToUser but specifically for advanced form components.",
"type": "string"
},
"retainPermissionToSharedData": {
"description": "Indicates whether permissions to shared folder should be retained.",
"type": "boolean"
},
"withdrawRequestFiles": {
"description": "Indicates whether request files should be withdrawn.",
"type": "boolean"
},
"withdrawFileLinks": {
"description": "Indicates whether sent files should be withdrawn.",
"type": "boolean"
}
}
},
"SendfileExternal.Post": {
"description": "Class SendfileExternal",
"properties": {
"to": {
"type": "array",
"items": {
"type": "string"
}
},
"cc": {
"type": "array",
"items": {
"type": "string"
}
},
"bcc": {
"type": "array",
"items": {
"type": "string"
}
},
"files": {
"type": "array",
"items": {
"type": "string"
}
},
"acl": {
"type": "string",
"enum": [
"verify_recipient",
"no_auth",
"otp",
"internal",
"anyone_auth",
"email_otp"
]
},
"expire": {
"type": "string",
"format": "date-time"
},
"draft": {
"type": "boolean"
},
"preview": {
"description": "Indicates that email is a preview email",
"type": "boolean"
},
"watermark": {
"description": "The watermark on the preview email",
"type": "string"
},
"secureBody": {
"type": "boolean"
},
"selfCopy": {
"type": "boolean"
},
"includeFingerprint": {
"type": "boolean"
},
"parentEmailId": {
"type": "integer"
},
"isSelfReturnReceipt": {
"type": "boolean"
},
"returnReceipts": {
"type": "array",
"items": {
"type": "string"
}
},
"type": {
"description": "Email type",
"type": "string",
"enum": [
"original",
"resend",
"forward",
"reply"
]
},
"uploading": {
"description": "Indicates whether upload is still in progress. Prevents sending if is set to true.",
"type": "boolean"
},
"body": {
"type": "string"
},
"subject": {
"type": "string"
}
}
},
"SendfileExternal.Put": {
"description": "Class SendfileExternal",
"properties": {
"to": {
"type": "array",
"items": {
"type": "string"
}
},
"cc": {
"type": "array",
"items": {
"type": "string"
}
},
"bcc": {
"type": "array",
"items": {
"type": "string"
}
},
"files": {
"type": "array",
"items": {
"type": "string"
}
},
"updateFid": {
"type": "array",
"items": {
"type": "string"
}
},
"acl": {
"type": "string",
"enum": [
"verify_recipient",
"no_auth",
"otp",
"internal",
"anyone_auth",
"email_otp"
]
},
"expire": {
"type": "string",
"format": "date-time"
},
"draft": {
"type": "boolean"
},
"preview": {
"description": "Indicates that email is a preview email",
"type": "boolean"
},
"watermark": {
"description": "The watermark on the preview email",
"type": "string"
},
"secureBody": {
"type": "boolean"
},
"selfCopy": {
"type": "boolean"
},
"includeFingerprint": {
"type": "boolean"
},
"isSelfReturnReceipt": {
"type": "boolean"
},
"returnReceipts": {
"type": "array",
"items": {
"type": "string"
}
},
"uploading": {
"description": "Indicates whether upload is still in progress. Prevents sending if is set to true.",
"type": "boolean"
},
"body": {
"type": "string"
},
"subject": {
"type": "string"
}
}
},
"UserTfaTotpResetSecret.Post": {
"description": "Class UserTfaTotpResetSecret",
"required": [
"password"
],
"properties": {
"password": {
"description": "The user's password",
"type": "string"
},
"otp": {
"description": "OTP to verify the new secret",
"type": "string"
}
}
},
"UserTfaTotpResetSecret.Put": {
"description": "Class UserTfaTotpResetSecret",
"required": [
"password"
],
"properties": {
"password": {
"description": "The user's password",
"type": "string"
},
"otp": {
"description": "OTP to verify the new secret",
"type": "string"
}
}
},
"UserEmail.Post": {
"description": "Class UserEmail",
"required": [
"oldEmail",
"newEmail"
],
"properties": {
"oldEmail": {
"description": "Email that the user currently has.",
"type": "string"
},
"newEmail": {
"description": "Email that the user should have after migration.",
"type": "string"
}
}
},
"UserEmail.Put": {
"description": "Class UserEmail",
"required": [
"oldEmail",
"newEmail"
],
"properties": {
"oldEmail": {
"description": "Email that the user currently has.",
"type": "string"
},
"newEmail": {
"description": "Email that the user should have after migration.",
"type": "string"
}
}
},
"TenantSuspend.Post": {
"description": "Class TenantSuspend",
"properties": {
"comment": {
"description": "Additional comment\\reason",
"type": "string"
}
}
},
"TenantSuspend.Put": {
"description": "Class TenantSuspend",
"properties": {
"comment": {
"description": "Additional comment\\reason",
"type": "string"
}
}
},
"UserRegister.Post": {
"description": "Class UserRegister",
"required": [
"email",
"password"
],
"properties": {
"email": {
"description": "User's email",
"type": "string"
},
"password": {
"description": "Password",
"type": "string"
},
"link": {
"description": "Ref link",
"type": "string"
},
"activationCode": {
"description": "activation code",
"type": "string"
},
"redirect": {
"description": "Special handling for redirect (sharedfiles)",
"type": "string"
}
}
},
"UserRegister.Put": {
"description": "Class UserRegister",
"required": [
"email",
"password"
],
"properties": {
"email": {
"description": "User's email",
"type": "string"
},
"password": {
"description": "Password",
"type": "string"
},
"link": {
"description": "Ref link",
"type": "string"
},
"activationCode": {
"description": "activation code",
"type": "string"
},
"redirect": {
"description": "Special handling for redirect (sharedfiles)",
"type": "string"
}
}
},
"ActivationCode.Post": {
"description": "Class ActivationCode",
"required": [
"referral"
],
"properties": {
"code": {
"description": "activation code",
"type": "string"
},
"email": {
"description": "email",
"type": "string"
},
"referral": {
"description": "referral",
"type": "string"
}
}
},
"ActivationCode.Put": {
"description": "Class ActivationCode",
"required": [
"referral"
],
"properties": {
"code": {
"description": "activation code",
"type": "string"
},
"email": {
"description": "email",
"type": "string"
},
"referral": {
"description": "referral",
"type": "string"
}
}
},
"UserLogin.Post": {
"description": "Class UserLogin",
"required": [
"username",
"password"
],
"properties": {
"username": {
"description": "The username of the user attempting to log in.",
"type": "string"
},
"password": {
"description": "The password of the user. It must be kept confidential and securely stored.",
"type": "string"
},
"referral": {
"description": "The URL that referred the user to this login action.",
"type": "string"
}
}
},
"UserLogin.Put": {
"description": "Class UserLogin",
"required": [
"username",
"password"
],
"properties": {
"username": {
"description": "The username of the user attempting to log in.",
"type": "string"
},
"password": {
"description": "The password of the user. It must be kept confidential and securely stored.",
"type": "string"
},
"referral": {
"description": "The URL that referred the user to this login action.",
"type": "string"
}
}
},
"SendRequestFile.Post": {
"description": "Class SendRequestFile",
"required": [
"fileIds"
],
"properties": {
"body": {
"type": "string"
},
"fileIds": {
"type": "array",
"items": {
"type": "string"
}
},
"selfCopy": {
"type": "boolean"
}
}
},
"SendRequestFile.Put": {
"description": "Class SendRequestFile",
"required": [
"fileIds"
],
"properties": {
"body": {
"type": "string"
},
"fileIds": {
"type": "array",
"items": {
"type": "string"
}
},
"selfCopy": {
"type": "boolean"
}
}
},
"FileInput.Post": {
"description": "Class FileInput",
"properties": {
"clientCreated": {
"description": "File creation date set from client",
"type": "string",
"format": "date"
},
"clientModified": {
"description": "File modify date set from client",
"type": "string",
"format": "date"
},
"note": {
"description": "Indicates whether the file is note",
"type": "boolean"
}
}
},
"UserTos.Post": {
"description": "Class UserTos",
"required": [
"accept"
],
"properties": {
"accept": {
"description": "accept",
"type": "boolean"
},
"referral": {
"description": "referral",
"type": "string"
}
}
},
"UserTos.Put": {
"description": "Class UserTos",
"required": [
"accept"
],
"properties": {
"accept": {
"description": "accept",
"type": "boolean"
},
"referral": {
"description": "referral",
"type": "string"
}
}
},
"FileCopyMove.Post": {
"description": "Class FileCopyMove",
"required": [
"destinationFolderId"
],
"properties": {
"destinationFolderId": {
"description": "Destination Folder unique identifier. Repositories Gateway folders are also supported.",
"type": "string"
},
"replace": {
"description": "Replace the file if the same file name exists. Default value is false",
"type": "boolean"
}
}
},
"FileCopyMove.Put": {
"description": "Class FileCopyMove",
"required": [
"destinationFolderId"
],
"properties": {
"destinationFolderId": {
"description": "Destination Folder unique identifier. Repositories Gateway folders are also supported.",
"type": "string"
},
"replace": {
"description": "Replace the file if the same file name exists. Default value is false",
"type": "boolean"
}
}
},
"UserRequestPasswordReset.Post": {
"description": "Class UserRequestPasswordReset",
"required": [
"email"
],
"properties": {
"email": {
"description": "User's email",
"type": "string"
}
}
},
"UserRequestPasswordReset.Put": {
"description": "Class UserRequestPasswordReset",
"required": [
"email"
],
"properties": {
"email": {
"description": "User's email",
"type": "string"
}
}
},
"OnPremiseSourceLogin.Post": {
"description": "Class OnPremiseSourceLogin",
"required": [
"login",
"password"
],
"properties": {
"login": {
"description": "Login",
"type": "string"
},
"password": {
"description": "Password",
"type": "string"
}
}
},
"OnPremiseSourceLogin.Put": {
"description": "Class OnPremiseSourceLogin",
"required": [
"login",
"password"
],
"properties": {
"login": {
"description": "Login",
"type": "string"
},
"password": {
"description": "Password",
"type": "string"
}
}
},
"AdminRoleGroupPolicy": {
"description": "Class AdminRoleGroupPolicy",
"properties": {
"id": {
"description": "Get the id of the policy group",
"type": "integer"
},
"description": {
"description": "Get the name of the policy group",
"type": "string"
},
"allowed": {
"description": "Get the policy group is allowed",
"type": "boolean"
},
"grouping": {
"description": "Get the policy group grouping",
"type": "string"
},
"dependencies": {
"description": "Get the policy group dependencies",
"$ref": "#/components/schemas/AdminRoleGroupPolicy"
}
}
},
"AdminRoleGroupPolicy.Post": {
"description": "Class AdminRoleGroupPolicy",
"required": [
"id"
],
"properties": {
"id": {
"description": "Specify the id of the policy group",
"type": "integer"
},
"allowed": {
"description": "Set the policy group allowed flag",
"type": "boolean"
}
}
},
"AdminRoleGroupPolicy.Put": {
"description": "Class AdminRoleGroupPolicy",
"required": [
"id"
],
"properties": {
"id": {
"description": "Specify the id of the policy group",
"type": "integer"
},
"allowed": {
"description": "Set the policy group allowed flag",
"type": "boolean"
}
}
},
"ProfileMappingOrder": {
"description": "Class ProfileMappingOrder",
"required": [
"impact",
"order"
],
"properties": {
"order": {
"description": "Get the User Profile mapping order",
"type": "array",
"items": {
"type": "integer"
}
},
"impact": {
"description": "Get the User Profile mapping order",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"ProfileMappingOrder.Post": {
"description": "Class ProfileMappingOrder",
"required": [
"order"
],
"properties": {
"peek": {
"description": "Set if we are peeking into the impact",
"type": "boolean"
},
"order": {
"description": "Set the User Profile mapping order",
"type": "array",
"items": {
"type": "integer"
}
}
}
},
"ProfileMappingOrder.Put": {
"description": "Class ProfileMappingOrder",
"required": [
"order"
],
"properties": {
"peek": {
"description": "Set if we are peeking into the impact",
"type": "boolean"
},
"order": {
"description": "Set the User Profile mapping order",
"type": "array",
"items": {
"type": "integer"
}
}
}
},
"FolderCopy.Post": {
"description": "Class FolderCopy",
"required": [
"destinationFolderId"
],
"properties": {
"destinationFolderId": {
"description": "Destination Folder unique identifier",
"type": "integer"
}
}
},
"FolderCopy.Put": {
"description": "Class FolderCopy",
"required": [
"destinationFolderId"
],
"properties": {
"destinationFolderId": {
"description": "Destination Folder unique identifier",
"type": "integer"
}
}
},
"ProfileMappingsTest": {
"description": "Class ProfileMappingsTest",
"properties": {
"result": {
"description": "Get profile mapping test results",
"type": "array",
"items": {
"$ref": "#/components/schemas/ProfileMapping"
}
}
}
},
"UserOtp.Post": {
"description": "Class UserOtpChallenge",
"required": [
"username",
"referral"
],
"properties": {
"username": {
"description": "username",
"type": "string"
},
"referral": {
"description": "referral",
"type": "string"
}
}
},
"UserOtp.Put": {
"description": "Class UserOtpChallenge",
"required": [
"username",
"referral"
],
"properties": {
"username": {
"description": "username",
"type": "string"
},
"referral": {
"description": "referral",
"type": "string"
}
}
},
"AttachmentDownloadEvent": {
"description": "Represents a single download or interaction event recorded for an email attachment.",
"properties": {
"created_time": {
"description": "Unix timestamp of when the event occurred.",
"type": "integer"
},
"event_name": {
"description": "The name of the event action (e.g. download_email, view_file, copy_file, file_withdrawn).",
"type": "string"
},
"username": {
"description": "Email address of the user who performed the action.",
"type": "string"
},
"successful": {
"description": "Indicates whether the action was completed successfully.",
"type": "boolean"
},
"withdrawn": {
"description": "Indicates whether the attachment was withdrawn at the time of the event.",
"type": "boolean"
},
"file_id": {
"description": "The unique identifier of the attachment file. Present only when the event is associated with a specific file.",
"type": "string"
},
"file_name": {
"description": "The name of the attachment file. Present only when the event is associated with a specific file.",
"type": "string"
},
"event_type": {
"description": "A secondary classification of the event type. Present only when applicable.",
"type": "string"
}
}
},
"AttachmentDownloadEvent.Post": {
"description": "Represents a single download or interaction event recorded for an email attachment.",
"properties": {
"created_time": {
"description": "Unix timestamp of when the event occurred.",
"type": "integer"
},
"event_name": {
"description": "The name of the event action (e.g. download_email, view_file, copy_file, file_withdrawn).",
"type": "string"
},
"username": {
"description": "Email address of the user who performed the action.",
"type": "string"
},
"successful": {
"description": "Indicates whether the action was completed successfully.",
"type": "boolean"
},
"withdrawn": {
"description": "Indicates whether the attachment was withdrawn at the time of the event.",
"type": "boolean"
},
"file_id": {
"description": "The unique identifier of the attachment file. Present only when the event is associated with a specific file.",
"type": "string"
},
"file_name": {
"description": "The name of the attachment file. Present only when the event is associated with a specific file.",
"type": "string"
},
"event_type": {
"description": "A secondary classification of the event type. Present only when applicable.",
"type": "string"
}
}
},
"AttachmentDownloadEvent.Put": {
"description": "Represents a single download or interaction event recorded for an email attachment.",
"properties": {
"created_time": {
"description": "Unix timestamp of when the event occurred.",
"type": "integer"
},
"event_name": {
"description": "The name of the event action (e.g. download_email, view_file, copy_file, file_withdrawn).",
"type": "string"
},
"username": {
"description": "Email address of the user who performed the action.",
"type": "string"
},
"successful": {
"description": "Indicates whether the action was completed successfully.",
"type": "boolean"
},
"withdrawn": {
"description": "Indicates whether the attachment was withdrawn at the time of the event.",
"type": "boolean"
},
"file_id": {
"description": "The unique identifier of the attachment file. Present only when the event is associated with a specific file.",
"type": "string"
},
"file_name": {
"description": "The name of the attachment file. Present only when the event is associated with a specific file.",
"type": "string"
},
"event_type": {
"description": "A secondary classification of the event type. Present only when applicable.",
"type": "string"
}
}
},
"TfaChallengeResponse": {
"description": "Represents the success response for TFA challenge and auth endpoints. Exactly one of the two properties is present in any given response.",
"properties": {
"redirectUrl": {
"description": "The URL to redirect to for the next step in the authentication flow. Present when TFA is accepted; mutually exclusive with challengeMsg.",
"type": "string"
},
"challengeMsg": {
"description": "A message from the TFA module to display to the user (for example, instructions to check their phone). Present when a challenge is in progress; mutually exclusive with redirectUrl.",
"type": "string"
}
}
},
"TfaChallengeResponse.Post": {
"description": "Represents the success response for TFA challenge and auth endpoints. Exactly one of the two properties is present in any given response.",
"properties": {
"redirectUrl": {
"description": "The URL to redirect to for the next step in the authentication flow. Present when TFA is accepted; mutually exclusive with challengeMsg.",
"type": "string"
},
"challengeMsg": {
"description": "A message from the TFA module to display to the user (for example, instructions to check their phone). Present when a challenge is in progress; mutually exclusive with redirectUrl.",
"type": "string"
}
}
},
"TfaChallengeResponse.Put": {
"description": "Represents the success response for TFA challenge and auth endpoints. Exactly one of the two properties is present in any given response.",
"properties": {
"redirectUrl": {
"description": "The URL to redirect to for the next step in the authentication flow. Present when TFA is accepted; mutually exclusive with challengeMsg.",
"type": "string"
},
"challengeMsg": {
"description": "A message from the TFA module to display to the user (for example, instructions to check their phone). Present when a challenge is in progress; mutually exclusive with redirectUrl.",
"type": "string"
}
}
},
"AttachmentDownloadReport": {
"description": "Represents the download tracking report for the attachments of a specific email.",
"properties": {
"downloads": {
"description": "List of download and interaction events recorded for the email's attachments.",
"type": "array",
"items": {
"$ref": "#/components/schemas/AttachmentDownloadEvent"
}
},
"sent_time": {
"description": "Unix timestamp of when the email was sent.",
"type": "integer"
},
"subject": {
"description": "Subject line of the email.",
"type": "string"
}
}
},
"AttachmentDownloadReport.Post": {
"description": "Represents the download tracking report for the attachments of a specific email.",
"properties": {
"downloads": {
"description": "List of download and interaction events recorded for the email's attachments.",
"type": "array",
"items": {
"$ref": "#/components/schemas/AttachmentDownloadEvent"
}
},
"sent_time": {
"description": "Unix timestamp of when the email was sent.",
"type": "integer"
},
"subject": {
"description": "Subject line of the email.",
"type": "string"
}
}
},
"AttachmentDownloadReport.Put": {
"description": "Represents the download tracking report for the attachments of a specific email.",
"properties": {
"downloads": {
"description": "List of download and interaction events recorded for the email's attachments.",
"type": "array",
"items": {
"$ref": "#/components/schemas/AttachmentDownloadEvent"
}
},
"sent_time": {
"description": "Unix timestamp of when the email was sent.",
"type": "integer"
},
"subject": {
"description": "Subject line of the email.",
"type": "string"
}
}
},
"SourcePreviewStatus": {
"description": "Represents the preview generation status for a file in a Repositories Gateway source. Returned by the GET /sources/{id}/preview endpoint (v15+).",
"properties": {
"status": {
"description": "The current preview generation status. Possible values: `ready`, `processing`, `failed`, `transfer_failed`, `not_supported_empty`.",
"type": "string"
},
"mime": {
"description": "The MIME type of the preview file. Populated only when status is `ready`; otherwise null.",
"type": "string"
},
"link": {
"description": "The URL path to retrieve the preview file. Populated only when status is `ready`; otherwise null.",
"type": "string"
}
}
},
"SourcePreviewStatus.Post": {
"description": "Represents the preview generation status for a file in a Repositories Gateway source. Returned by the GET /sources/{id}/preview endpoint (v15+).",
"properties": {
"status": {
"description": "The current preview generation status. Possible values: `ready`, `processing`, `failed`, `transfer_failed`, `not_supported_empty`.",
"type": "string"
},
"mime": {
"description": "The MIME type of the preview file. Populated only when status is `ready`; otherwise null.",
"type": "string"
},
"link": {
"description": "The URL path to retrieve the preview file. Populated only when status is `ready`; otherwise null.",
"type": "string"
}
}
},
"SourcePreviewStatus.Put": {
"description": "Represents the preview generation status for a file in a Repositories Gateway source. Returned by the GET /sources/{id}/preview endpoint (v15+).",
"properties": {
"status": {
"description": "The current preview generation status. Possible values: `ready`, `processing`, `failed`, `transfer_failed`, `not_supported_empty`.",
"type": "string"
},
"mime": {
"description": "The MIME type of the preview file. Populated only when status is `ready`; otherwise null.",
"type": "string"
},
"link": {
"description": "The URL path to retrieve the preview file. Populated only when status is `ready`; otherwise null.",
"type": "string"
}
}
},
"FilePathResponse": {
"description": "Represents the full ancestor path of a file, from the workspace root down to the file's parent folder. Returned by the GET /files/{id}/path endpoint.",
"properties": {
"data": {
"description": "Ordered list of folder nodes representing the path from the workspace root to the file's parent folder.",
"type": "array",
"items": {
"$ref": "FolderTreeItem"
}
},
"links": {
"description": "Optional HATEOAS links. Present only when the request includes link options.",
"type": "array",
"items": {
"$ref": "HateoasLink"
}
}
}
},
"FilePathResponse.Post": {
"description": "Represents the full ancestor path of a file, from the workspace root down to the file's parent folder. Returned by the GET /files/{id}/path endpoint.",
"properties": {
"data": {
"description": "Ordered list of folder nodes representing the path from the workspace root to the file's parent folder.",
"type": "array",
"items": {
"$ref": "FolderTreeItem"
}
},
"links": {
"description": "Optional HATEOAS links. Present only when the request includes link options.",
"type": "array",
"items": {
"$ref": "HateoasLink"
}
}
}
},
"FilePathResponse.Put": {
"description": "Represents the full ancestor path of a file, from the workspace root down to the file's parent folder. Returned by the GET /files/{id}/path endpoint.",
"properties": {
"data": {
"description": "Ordered list of folder nodes representing the path from the workspace root to the file's parent folder.",
"type": "array",
"items": {
"$ref": "FolderTreeItem"
}
},
"links": {
"description": "Optional HATEOAS links. Present only when the request includes link options.",
"type": "array",
"items": {
"$ref": "HateoasLink"
}
}
}
},
"TotpSetupResponse": {
"description": "Represents the success response when initiating a TOTP secret setup.",
"properties": {
"username": {
"description": "The username associated with the TOTP secret.",
"type": "string"
},
"issuer": {
"description": "The issuer name used in the TOTP URI, typically the server hostname.",
"type": "string"
},
"secret": {
"description": "The base32-encoded TOTP secret key to be stored in the authenticator app.",
"type": "string"
},
"image": {
"description": "A base64-encoded QR code image encoding the TOTP URI for scanning with an authenticator app.",
"type": "string"
},
"setup_instruction_1": {
"description": "Optional first setup instruction. Only present when provided by the authentication backend.",
"type": "string"
},
"setup_instruction_2": {
"description": "Optional second setup instruction. Only present when provided by the authentication backend.",
"type": "string"
}
}
},
"TotpSetupResponse.Post": {
"description": "Represents the success response when initiating a TOTP secret setup.",
"properties": {
"username": {
"description": "The username associated with the TOTP secret.",
"type": "string"
},
"issuer": {
"description": "The issuer name used in the TOTP URI, typically the server hostname.",
"type": "string"
},
"secret": {
"description": "The base32-encoded TOTP secret key to be stored in the authenticator app.",
"type": "string"
},
"image": {
"description": "A base64-encoded QR code image encoding the TOTP URI for scanning with an authenticator app.",
"type": "string"
},
"setup_instruction_1": {
"description": "Optional first setup instruction. Only present when provided by the authentication backend.",
"type": "string"
},
"setup_instruction_2": {
"description": "Optional second setup instruction. Only present when provided by the authentication backend.",
"type": "string"
}
}
},
"TotpSetupResponse.Put": {
"description": "Represents the success response when initiating a TOTP secret setup.",
"properties": {
"username": {
"description": "The username associated with the TOTP secret.",
"type": "string"
},
"issuer": {
"description": "The issuer name used in the TOTP URI, typically the server hostname.",
"type": "string"
},
"secret": {
"description": "The base32-encoded TOTP secret key to be stored in the authenticator app.",
"type": "string"
},
"image": {
"description": "A base64-encoded QR code image encoding the TOTP URI for scanning with an authenticator app.",
"type": "string"
},
"setup_instruction_1": {
"description": "Optional first setup instruction. Only present when provided by the authentication backend.",
"type": "string"
},
"setup_instruction_2": {
"description": "Optional second setup instruction. Only present when provided by the authentication backend.",
"type": "string"
}
}
},
"HateoasLink": {
"description": "Represents a single HATEOAS link in an API response.",
"properties": {
"rel": {
"description": "The link relation type, describing how the linked resource relates to the current resource (e.g., `self`).",
"type": "string"
},
"href": {
"description": "The URL of the linked resource.",
"type": "string"
}
}
},
"HateoasLink.Post": {
"description": "Represents a single HATEOAS link in an API response.",
"properties": {
"rel": {
"description": "The link relation type, describing how the linked resource relates to the current resource (e.g., `self`).",
"type": "string"
},
"href": {
"description": "The URL of the linked resource.",
"type": "string"
}
}
},
"HateoasLink.Put": {
"description": "Represents a single HATEOAS link in an API response.",
"properties": {
"rel": {
"description": "The link relation type, describing how the linked resource relates to the current resource (e.g., `self`).",
"type": "string"
},
"href": {
"description": "The URL of the linked resource.",
"type": "string"
}
}
},
"TfaConfigResponse": {
"description": "Represents the Two-Factor Authentication configuration for the current user.",
"properties": {
"module": {
"description": "The name of the active Two-Factor Authentication (TFA) module.",
"type": "string"
},
"passcodeLabel": {
"description": "The label to display for the passcode input field.",
"type": "string"
},
"passcodeDescription": {
"description": "A description of the passcode input field.",
"type": "string"
},
"rechallengeLabel": {
"description": "The label for the rechallenge action.",
"type": "string"
},
"challengeShouldSendPassword": {
"description": "Indicates whether the password should be sent along with the challenge request.",
"type": "boolean"
},
"challengeWaitMessage": {
"description": "A message to display to the user while waiting for the challenge response.",
"type": "string"
},
"rechallengeMessage": {
"description": "A message to display when prompting the user to rechallenge.",
"type": "string"
},
"rememberDeviceEnabled": {
"description": "Indicates whether the remember device feature is enabled for this user.",
"type": "boolean"
},
"passcodeMask": {
"description": "Indicates whether the passcode input should be masked.",
"type": "boolean"
},
"mobileNumber": {
"description": "The user's mobile number. Present only when the TFA module is SMSOTP.",
"type": "string"
},
"allowNumberChange": {
"description": "Indicates whether the user is allowed to change their mobile number. Present only when the TFA module is SMSOTP.",
"type": "boolean"
}
}
},
"TfaConfigResponse.Post": {
"description": "Represents the Two-Factor Authentication configuration for the current user.",
"properties": {
"module": {
"description": "The name of the active Two-Factor Authentication (TFA) module.",
"type": "string"
},
"passcodeLabel": {
"description": "The label to display for the passcode input field.",
"type": "string"
},
"passcodeDescription": {
"description": "A description of the passcode input field.",
"type": "string"
},
"rechallengeLabel": {
"description": "The label for the rechallenge action.",
"type": "string"
},
"challengeShouldSendPassword": {
"description": "Indicates whether the password should be sent along with the challenge request.",
"type": "boolean"
},
"challengeWaitMessage": {
"description": "A message to display to the user while waiting for the challenge response.",
"type": "string"
},
"rechallengeMessage": {
"description": "A message to display when prompting the user to rechallenge.",
"type": "string"
},
"rememberDeviceEnabled": {
"description": "Indicates whether the remember device feature is enabled for this user.",
"type": "boolean"
},
"passcodeMask": {
"description": "Indicates whether the passcode input should be masked.",
"type": "boolean"
},
"mobileNumber": {
"description": "The user's mobile number. Present only when the TFA module is SMSOTP.",
"type": "string"
},
"allowNumberChange": {
"description": "Indicates whether the user is allowed to change their mobile number. Present only when the TFA module is SMSOTP.",
"type": "boolean"
}
}
},
"TfaConfigResponse.Put": {
"description": "Represents the Two-Factor Authentication configuration for the current user.",
"properties": {
"module": {
"description": "The name of the active Two-Factor Authentication (TFA) module.",
"type": "string"
},
"passcodeLabel": {
"description": "The label to display for the passcode input field.",
"type": "string"
},
"passcodeDescription": {
"description": "A description of the passcode input field.",
"type": "string"
},
"rechallengeLabel": {
"description": "The label for the rechallenge action.",
"type": "string"
},
"challengeShouldSendPassword": {
"description": "Indicates whether the password should be sent along with the challenge request.",
"type": "boolean"
},
"challengeWaitMessage": {
"description": "A message to display to the user while waiting for the challenge response.",
"type": "string"
},
"rechallengeMessage": {
"description": "A message to display when prompting the user to rechallenge.",
"type": "string"
},
"rememberDeviceEnabled": {
"description": "Indicates whether the remember device feature is enabled for this user.",
"type": "boolean"
},
"passcodeMask": {
"description": "Indicates whether the passcode input should be masked.",
"type": "boolean"
},
"mobileNumber": {
"description": "The user's mobile number. Present only when the TFA module is SMSOTP.",
"type": "string"
},
"allowNumberChange": {
"description": "Indicates whether the user is allowed to change their mobile number. Present only when the TFA module is SMSOTP.",
"type": "boolean"
}
}
},
"PreauthResponse": {
"description": "Represents the success response for the preauth endpoint.",
"properties": {
"username": {
"description": "The username used for preauth.",
"type": "string"
},
"redirectUrl": {
"description": "The URL to redirect to. Present when type is `redirect`, null when type is `password`.",
"type": "string"
},
"type": {
"description": "The next step in the login flow. Accepted values: `password` (show a password field), `redirect` (redirect the user to redirectUrl).",
"type": "string"
},
"otp": {
"description": "Whether the login flow requires OTP authentication.",
"type": "boolean"
}
}
},
"PreauthResponse.Post": {
"description": "Represents the success response for the preauth endpoint.",
"properties": {
"username": {
"description": "The username used for preauth.",
"type": "string"
},
"redirectUrl": {
"description": "The URL to redirect to. Present when type is `redirect`, null when type is `password`.",
"type": "string"
},
"type": {
"description": "The next step in the login flow. Accepted values: `password` (show a password field), `redirect` (redirect the user to redirectUrl).",
"type": "string"
},
"otp": {
"description": "Whether the login flow requires OTP authentication.",
"type": "boolean"
}
}
},
"PreauthResponse.Put": {
"description": "Represents the success response for the preauth endpoint.",
"properties": {
"username": {
"description": "The username used for preauth.",
"type": "string"
},
"redirectUrl": {
"description": "The URL to redirect to. Present when type is `redirect`, null when type is `password`.",
"type": "string"
},
"type": {
"description": "The next step in the login flow. Accepted values: `password` (show a password field), `redirect` (redirect the user to redirectUrl).",
"type": "string"
},
"otp": {
"description": "Whether the login flow requires OTP authentication.",
"type": "boolean"
}
}
},
"FolderTreeItem": {
"description": "Represents a single node in a folder's ancestor chain, from root down to the target folder.",
"properties": {
"id": {
"description": "The unique identifier of the folder node.",
"type": "string"
},
"name": {
"description": "The display name of the folder node.",
"type": "string"
}
}
},
"FolderTreeItem.Post": {
"description": "Represents a single node in a folder's ancestor chain, from root down to the target folder.",
"properties": {
"id": {
"description": "The unique identifier of the folder node.",
"type": "string"
},
"name": {
"description": "The display name of the folder node.",
"type": "string"
}
}
},
"FolderTreeItem.Put": {
"description": "Represents a single node in a folder's ancestor chain, from root down to the target folder.",
"properties": {
"id": {
"description": "The unique identifier of the folder node.",
"type": "string"
},
"name": {
"description": "The display name of the folder node.",
"type": "string"
}
}
},
"ClientScopesResponse": {
"description": "Represents the success response for the client scopes endpoint.",
"properties": {
"data": {
"description": "List of API resource scope strings the client is authorized to access (e.g. 'folders/*', 'files/*').",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"ClientScopesResponse.Post": {
"description": "Represents the success response for the client scopes endpoint.",
"properties": {
"data": {
"description": "List of API resource scope strings the client is authorized to access (e.g. 'folders/*', 'files/*').",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"ClientScopesResponse.Put": {
"description": "Represents the success response for the client scopes endpoint.",
"properties": {
"data": {
"description": "List of API resource scope strings the client is authorized to access (e.g. 'folders/*', 'files/*').",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"AuthRedirectResponse": {
"description": "Represents the success response for authentication flow endpoints that advance the user to the next step.",
"properties": {
"redirectUrl": {
"description": "The URL to redirect to for the next step in the flow.",
"type": "string"
}
}
},
"AuthRedirectResponse.Post": {
"description": "Represents the success response for authentication flow endpoints that advance the user to the next step.",
"properties": {
"redirectUrl": {
"description": "The URL to redirect to for the next step in the flow.",
"type": "string"
}
}
},
"AuthRedirectResponse.Put": {
"description": "Represents the success response for authentication flow endpoints that advance the user to the next step.",
"properties": {
"redirectUrl": {
"description": "The URL to redirect to for the next step in the flow.",
"type": "string"
}
}
},
"LoginResponse": {
"description": "Represents the success response for the login endpoint.",
"properties": {
"success": {
"description": "Indicates whether the login was successful. Always true on a successful response.",
"type": "boolean"
},
"redirectUrl": {
"description": "The URL to redirect to for the next step in the authentication flow.",
"type": "string"
}
}
},
"LoginResponse.Post": {
"description": "Represents the success response for the login endpoint.",
"properties": {
"success": {
"description": "Indicates whether the login was successful. Always true on a successful response.",
"type": "boolean"
},
"redirectUrl": {
"description": "The URL to redirect to for the next step in the authentication flow.",
"type": "string"
}
}
},
"LoginResponse.Put": {
"description": "Represents the success response for the login endpoint.",
"properties": {
"success": {
"description": "Indicates whether the login was successful. Always true on a successful response.",
"type": "boolean"
},
"redirectUrl": {
"description": "The URL to redirect to for the next step in the authentication flow.",
"type": "string"
}
}
},
"TosResponse": {
"description": "Represents the Terms of Service content returned for the current user.",
"properties": {
"type": {
"description": "The type of Terms of Service.",
"type": "string"
},
"data": {
"description": "The full Terms of Service content.",
"type": "string"
},
"acceptanceText": {
"description": "The text to display on the acceptance button or checkbox.",
"type": "string"
},
"occurrence": {
"description": "How often the Terms of Service is shown to the user.",
"type": "string"
},
"isRequired": {
"description": "Indicates whether the user is required to accept the Terms of Service.",
"type": "boolean"
}
}
},
"TosResponse.Post": {
"description": "Represents the Terms of Service content returned for the current user.",
"properties": {
"type": {
"description": "The type of Terms of Service.",
"type": "string"
},
"data": {
"description": "The full Terms of Service content.",
"type": "string"
},
"acceptanceText": {
"description": "The text to display on the acceptance button or checkbox.",
"type": "string"
},
"occurrence": {
"description": "How often the Terms of Service is shown to the user.",
"type": "string"
},
"isRequired": {
"description": "Indicates whether the user is required to accept the Terms of Service.",
"type": "boolean"
}
}
},
"TosResponse.Put": {
"description": "Represents the Terms of Service content returned for the current user.",
"properties": {
"type": {
"description": "The type of Terms of Service.",
"type": "string"
},
"data": {
"description": "The full Terms of Service content.",
"type": "string"
},
"acceptanceText": {
"description": "The text to display on the acceptance button or checkbox.",
"type": "string"
},
"occurrence": {
"description": "How often the Terms of Service is shown to the user.",
"type": "string"
},
"isRequired": {
"description": "Indicates whether the user is required to accept the Terms of Service.",
"type": "boolean"
}
}
},
"InitiateUploadZipPostRequest": {
"type": "object",
"properties": {
"filename": {
"type": "string",
"description": "Name of the file to be uploaded."
},
"totalSize": {
"type": "integer",
"description": "Total size of the file to be uploaded, in bytes."
},
"totalChunks": {
"type": "integer",
"minimum": 1,
"description": "Total number of chunks the file will be split into. Must be at least 1."
},
"clientCreated": {
"type": "string",
"format": "date",
"description": "File creation timestamp as reported by the client (e.g. from the OS or browser)."
},
"clientModified": {
"type": "string",
"format": "date",
"description": "File last-modified timestamp as reported by the client (e.g. from the OS or browser)."
},
"proximateHost": {
"type": "string",
"description": "Proximate hostname used to direct client uploads to the nearest available storage endpoint."
},
"tracking_id": {
"type": "string",
"format": "uuid",
"description": "Tracking ID for correlating the upload with an external transfer"
},
"resume": {
"type": "boolean",
"description": "Indicates whether this is a resumption of a previously interrupted upload. Only applicable when a file with the same name already exists. Currently used internally for SFTP transfers only."
},
"uncompressedSize": {
"type": "integer",
"description": "Total uncompressed size of the archive file, in bytes."
}
},
"required": [
"filename",
"uncompressedSize"
]
},
"InitiateUploadPostRequest": {
"type": "object",
"properties": {
"filename": {
"type": "string",
"description": "Name of the file to be uploaded."
},
"totalSize": {
"type": "integer",
"description": "Total size of the file to be uploaded, in bytes."
},
"totalChunks": {
"type": "integer",
"minimum": 1,
"description": "Total number of chunks the file will be split into. Must be at least 1."
},
"clientCreated": {
"type": "string",
"format": "date",
"description": "File creation timestamp as reported by the client (e.g. from the OS or browser)."
},
"clientModified": {
"type": "string",
"format": "date",
"description": "File last-modified timestamp as reported by the client (e.g. from the OS or browser)."
},
"proximateHost": {
"type": "string",
"description": "Proximate hostname used to direct client uploads to the nearest available storage endpoint."
},
"tracking_id": {
"type": "string",
"format": "uuid",
"description": "Tracking ID for correlating the upload with an external transfer"
},
"resume": {
"type": "boolean",
"description": "Indicates whether this is a resumption of a previously interrupted upload. Only applicable when a file with the same name already exists. Currently used internally for SFTP transfers only."
}
},
"required": [
"filename"
]
},
"BaseChunkUploadRequest": {
"type": "object",
"properties": {
"compressionMode": {
"type": "string",
"enum": [
"NORMAL",
"GZIP",
"ZLIB"
],
"description": "The compression algorithm applied to this chunk.
`NORMAL` \u2013 No compression; the chunk is sent as-is.
`GZIP` \u2013 Chunk is compressed using GZIP.
`ZLIB` \u2013 Chunk is compressed using ZLIB."
},
"compressionSize": {
"type": "integer",
"description": "The size of the chunk after compression."
},
"content": {
"type": "string",
"description": "The content of the chunk. If the request is in JSON format, this will be base64-encoded."
},
"originalSize": {
"type": "integer",
"description": "The original upload content size before compression."
},
"index": {
"type": "integer",
"description": "The sequential index of the chunk (starts from 1)."
},
"lastChunk": {
"type": "integer",
"description": "Indicates if this is the last chunk of the file (1 if last, 0 otherwise)."
}
},
"required": [
"compressionMode",
"compressionSize",
"content",
"originalSize"
]
},
"UserBasic": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique identifier (UUID) for the user."
},
"email": {
"type": "string",
"description": "Email address associated with the user."
},
"name": {
"type": "string",
"description": "Full name of the user."
},
"profileIcon": {
"type": "string",
"description": "URL or identifier for the user's profile icon."
}
}
},
"Fingerprint": {
"type": "object",
"properties": {
"algo": {
"type": "string",
"description": "The algorithm used to generate the fingerprint (e.g., sha3-256, md5)."
},
"hash": {
"type": "string",
"description": "The resulting hash value representing the fingerprint of the file or object."
}
}
},
"MobileInfo": {
"type": "object",
"properties": {
"wopiSrc": {
"type": "string",
"description": "The WOPI (Web Application Open Platform Interface) source URL for the mobile application."
},
"userId": {
"type": "string",
"description": "Unique identifier of the user."
},
"service": {
"type": "string",
"description": "The WOPI service ID."
},
"scheme": {
"type": "string",
"description": "URI scheme used by the mobile application to handle the file."
},
"schemeSupport": {
"type": "string",
"description": "Indicates the level of support the mobile app has for the URI scheme."
}
}
},
"SafeEdit": {
"type": "object",
"properties": {
"safeEditLocked": {
"type": "boolean",
"description": "Indicates if the file is locked through a SafeEdit session."
},
"user": {
"description": "The user responsible for locking the file via SafeEdit.",
"allOf": [
{
"$ref": "#/components/schemas/UserBasic"
}
]
}
}
},
"BaseSendMailPostRequest": {
"type": "object",
"properties": {
"to": {
"type": "array",
"description": "List of recipients' email addresses (To field).",
"items": {
"type": "string",
"format": "email"
}
},
"cc": {
"type": "array",
"description": "List of recipients' email addresses (CC field).",
"items": {
"type": "string",
"format": "email"
}
},
"bcc": {
"type": "array",
"description": "List of recipients' email addresses (BCC field).",
"items": {
"type": "string",
"format": "email"
}
},
"files": {
"type": "array",
"description": "List of file UUIDs to attach to the email.",
"items": {
"type": "string"
}
},
"acl": {
"type": "string",
"enum": [
"verify_recipient",
"no_auth",
"otp",
"internal",
"anyone_auth",
"email_otp"
],
"description": "Defines the access control level for the email.
`verify_recipient` \u2013 Accessible only to specified recipients.
`no_auth` \u2013 Public access, no authentication required.
`otp` \u2013 Accessible to recipients; allows one-time passcode (OTP) via SMS for authentication.
`internal` \u2013 Accessible to recipients and users within the organization.
`anyone_auth` \u2013 Accessible to recipients and any authenticated user.
`email_otp` \u2013 Accessible to recipients; allows one-time passcode (OTP) via email for authentication."
},
"expire": {
"type": "string",
"format": "date",
"description": "The expiration date of the email."
},
"draft": {
"type": "boolean",
"description": "Indicates if the email is being saved as a draft."
},
"preview": {
"type": "boolean",
"description": "Indicates if the email is a view-only version."
},
"watermark": {
"type": "string",
"description": "Text watermark applied to the email attachments (only applicable when `preview` is enabled)."
},
"secureBody": {
"type": "boolean",
"description": "If true, the email body is hidden from the notification email and is only visible to authenticated recipients when they open the secure link."
},
"selfCopy": {
"type": "boolean",
"description": "Indicates if the sender should receive a copy of the email."
},
"includeFingerprint": {
"type": "boolean",
"description": "If true, a cryptographic hash (fingerprint) of each attached file is included in the notification email, allowing recipients to verify file integrity."
},
"parentEmailId": {
"type": "string",
"description": "The parent email ID used for email threading. Applicable only for `forward` or `reply` types."
},
"isSelfReturnReceipt": {
"type": "boolean",
"description": "(Deprecated) Send download notification to the sender. Use 'returnReceipts' instead."
},
"returnReceipts": {
"type": "array",
"description": "List of recipients who should receive a download notification.",
"items": {
"type": "string",
"format": "email"
}
},
"type": {
"type": "string",
"enum": [
"original",
"forward",
"reply",
"resend"
],
"description": "The type of email. Defaults to `original`.
`original` \u2013 A new email.
`forward` \u2013 Forwarding an existing email to new recipients.
`reply` \u2013 A reply to an existing email.
`resend` \u2013 Resending a previously sent email."
},
"uploading": {
"type": "boolean",
"description": "Indicates whether file upload is still in progress. Prevents sending if set to `true`."
},
"body": {
"type": "string",
"description": "The body content of the email."
},
"subject": {
"type": "string",
"maxLength": 998,
"description": "The subject of the email (maximum length: 998 characters)."
},
"webFormId": {
"type": "string",
"description": "The web form ID associated with the email."
},
"webFormFields": {
"type": "object",
"description": "Custom web form fields associated with the email."
},
"notifyExpired": {
"type": "boolean",
"description": "Indicates whether to send a notification email to the sender when the email expires."
},
"sharedMailboxId": {
"type": "string",
"description": "UUID of the shared mailbox to send from. When set, the email is sent on behalf of the shared mailbox rather than the individual user."
},
"trackingAccess": {
"type": "array",
"description": "List of email addresses to grant access to the email's download tracking dashboard.",
"items": {
"type": "string",
"format": "email"
}
}
}
},
"Variables": {
"type": "object",
"properties": {
"variable": {
"type": "string",
"description": "The variable name"
},
"value": {
"description": "The variable value"
}
}
},
"EmailReturnRecipient": {
"type": "object",
"properties": {
"userId": {
"type": "string",
"description": "Unique identifier of the user who requested the return receipt."
},
"user": {
"description": "Details of the user who requested the return receipt.",
"allOf": [
{
"$ref": "#/components/schemas/UserBasic"
}
]
}
}
},
"TrackingAccessRecipient": {
"type": "object",
"properties": {
"userId": {
"type": "string",
"description": "Unique identifier of the user associated with the recipient."
},
"type": {
"type": "integer",
"description": "Recipient type.
`0` \u2013 To.
`1` \u2013 CC.
`2` \u2013 BCC."
},
"email": {
"type": "string",
"description": "Email address of the recipient."
},
"isDistributionList": {
"type": "boolean",
"description": "Indicates if the recipient is a distribution list rather than an individual user."
},
"user": {
"description": "Details of the user associated with the recipient.",
"allOf": [
{
"$ref": "#/components/schemas/UserBasic"
}
]
},
"revoked": {
"type": "boolean",
"description": "Indicates whether the recipient's tracking access has been revoked."
}
}
},
"DrmFile": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Name of the DRM-protected file."
},
"size": {
"type": "integer",
"description": "Size of the DRM-protected file in bytes."
}
}
},
"Mail": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique identifier of the email."
},
"senderId": {
"type": "string",
"description": "Unique identifier of the sender."
},
"templateId": {
"type": "integer",
"description": "Unique identifier of the email template used."
},
"status": {
"type": "string",
"description": "Current status of the email (e.g., sent, draft, error, etc.)."
},
"type": {
"type": "string",
"description": "Type of the email (e.g., original, reply, forward, etc.)."
},
"date": {
"type": "string",
"format": "date",
"description": "Date the email was last modified or sent."
},
"deleted": {
"type": "boolean",
"description": "Indicates if the email has been deleted."
},
"withdrawnDate": {
"type": "string",
"format": "date",
"description": "Date when the email was withdrawn, if applicable."
},
"emailPackageId": {
"type": "string",
"description": "Unique identifier of the associated email package."
},
"isPreview": {
"type": "boolean",
"description": "Indicates whether the email is a view-only version, typically used for previewing attachments without enabling downloading."
},
"isUserSent": {
"type": "boolean",
"description": "Indicates whether the email was sent by the current user or another user."
},
"watermark": {
"type": "string",
"description": "Text watermark applied to the email attachments (applicable only for view-only version)."
},
"variables": {
"description": "List of dynamic variables used in the email.",
"type": "array",
"items": {
"$ref": "#/components/schemas/Variables"
}
},
"recipients": {
"description": "List of recipients for the email.",
"type": "array",
"items": {
"$ref": "#/components/schemas/Recipient"
}
},
"secureBody": {
"type": "boolean",
"description": "Indicates if the email body is secured."
},
"modifiedDate": {
"type": "string",
"format": "date",
"description": "Date the email was last modified."
},
"parentEmailId": {
"type": "string",
"description": "Unique identifier of the parent email, if applicable."
},
"emailReturnReceipt": {
"description": "List of recipients who requested return receipts.",
"type": "array",
"items": {
"$ref": "#/components/schemas/EmailReturnRecipient"
}
},
"error": {
"type": "string",
"description": "Error message associated with the email, if any."
},
"subject": {
"type": "string",
"description": "Subject line of the email."
},
"attachmentCount": {
"type": "integer",
"description": "Number of attachments in the email."
},
"expirationDate": {
"type": "string",
"format": "date",
"description": "Expiration date of the email package, if applicable."
},
"avStatus": {
"type": "string",
"description": "Antivirus (AV) scan status of the email."
},
"dlpStatus": {
"type": "string",
"description": "Data Loss Prevention (DLP) scan status of the email."
},
"hasTrackingAccess": {
"type": "boolean",
"description": "Indicates if tracking access is enabled for the email."
},
"trackingAccess": {
"description": "List of recipients with tracking access.",
"type": "array",
"items": {
"$ref": "#/components/schemas/TrackingAccessRecipient"
}
},
"policyDirective": {
"type": "integer",
"description": "Indicates the restriction type applied to the email"
},
"isRead": {
"type": "boolean",
"description": "Indicates if the email has been read."
},
"bucket": {
"type": "string",
"description": "The bucket where the email is stored. (e.g. inbox, sent, trash)"
},
"body": {
"type": "string",
"description": "The body of the email."
},
"package": {
"description": "Details of the associated email package.",
"allOf": [
{
"$ref": "#/components/schemas/Package"
}
]
},
"rawBody": {
"type": "string",
"description": "Raw email body content without HTML markup."
},
"headline": {
"type": "string",
"description": "Headline or main title of the email."
},
"notice": {
"type": "string",
"description": "Notice part of the email."
},
"fullHtmlBody": {
"type": "string",
"description": "Full HTML body of the email."
},
"emailFrom": {
"type": "string",
"description": "The email address from which the email was sent."
},
"templateBody": {
"type": "string",
"description": "Body content generated from the email template."
},
"webFormId": {
"type": "string",
"description": "Unique identifier of the web form associated with the email."
},
"webFormFields": {
"description": "Fields included in the associated web form with the mail."
},
"sender": {
"description": "Details of the sender.",
"allOf": [
{
"$ref": "#/components/schemas/UserBasic"
}
]
},
"sharedMailboxId": {
"type": "string",
"description": "Unique identifier of the shared mailbox, if applicable."
},
"htmlBody": {
"type": "string",
"description": "HTML version of the email body."
},
"actor": {
"description": "The user responsible for sending the email, applicable when the email is sent on behalf of a shared mailbox.",
"allOf": [
{
"$ref": "#/components/schemas/UserBasic"
}
]
},
"darkModeStyle": {
"type": "string",
"description": "CSS styles applied for dark mode."
},
"exists": {
"type": "boolean",
"description": "Indicates whether the email already exists in the system."
}
}
},
"DestinationFolderIdRequest": {
"type": "object",
"properties": {
"destinationFolderId": {
"type": "string",
"description": "The ID of the destination folder where the item will be copied/moved."
},
"addVersion": {
"type": "boolean",
"description": "If a file with the same name exists, create a new version instead of overwriting it. Default is True."
}
},
"required": [
"destinationFolderId"
]
},
"UserAttachment": {
"type": "object",
"properties": {
"emailId": {
"type": "string"
},
"subject": {
"type": "string",
"description": "Subject line of the email containing this attachment."
},
"size": {
"type": "string",
"description": "Size of the attachment in bytes."
},
"name": {
"type": "string",
"description": "File name of the attachment."
},
"sentDate": {
"type": "string",
"format": "date",
"description": "Date and time when the email was sent."
},
"modifiedDate": {
"type": "string",
"format": "date",
"description": "Date and time when the attachment was last modified."
},
"attachmentId": {
"type": "string",
"description": "Unique identifier (UUID) of the attachment."
},
"mime": {
"type": "string",
"description": "MIME type of the attachment."
},
"webFormId": {
"type": "string",
"description": "Identifier of the web form associated with the attachment, if any."
},
"type": {
"type": "string",
"description": "Type of the attachment."
}
}
},
"MetaData": {
"type": "object",
"properties": {
"total": {
"type": "integer",
"description": "Total number of items available."
},
"limit": {
"type": "integer",
"description": "Maximum number of items returned per page."
},
"offset": {
"type": "integer",
"description": "Number of items skipped before the current page."
}
}
},
"MailAttachments": {
"type": "object",
"properties": {
"data": {
"description": "List of email attachments.",
"type": "array",
"items": {
"$ref": "#/components/schemas/UserAttachment"
}
},
"metadata": {
"description": "Pagination metadata for the result set.",
"allOf": [
{
"$ref": "#/components/schemas/MetaData"
}
]
}
}
},
"Mail1": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique identifier of the email."
},
"senderId": {
"type": "string",
"description": "Unique identifier of the sender."
},
"templateId": {
"type": "integer",
"description": "Unique identifier of the email template used."
},
"status": {
"type": "string",
"description": "Current status of the email (e.g., sent, draft, error, etc.)."
},
"type": {
"type": "string",
"description": "Type of the email (e.g., original, reply, forward, etc.)."
},
"date": {
"type": "string",
"format": "date",
"description": "Date the email was last modified or sent."
},
"deleted": {
"type": "boolean",
"description": "Indicates if the email has been deleted."
},
"withdrawnDate": {
"type": "string",
"format": "date",
"description": "Date when the email was withdrawn, if applicable."
},
"emailPackageId": {
"type": "string",
"description": "Unique identifier of the associated email package."
},
"isPreview": {
"type": "boolean",
"description": "Indicates whether the email is a view-only version, typically used for previewing attachments without enabling downloading."
},
"isUserSent": {
"type": "boolean",
"description": "Indicates whether the email was sent by the current user or another user."
},
"watermark": {
"type": "string",
"description": "Text watermark applied to the email attachments (applicable only for view-only version)."
},
"recipients": {
"description": "List of recipients for the email.",
"type": "array",
"items": {
"$ref": "#/components/schemas/Recipient"
}
},
"secureBody": {
"type": "boolean",
"description": "Indicates if the email body is secured."
},
"modifiedDate": {
"type": "string",
"format": "date",
"description": "Date the email was last modified."
},
"parentEmailId": {
"type": "string",
"description": "Unique identifier of the parent email, if applicable."
},
"emailReturnReceipt": {
"description": "List of recipients who requested return receipts.",
"type": "array",
"items": {
"$ref": "#/components/schemas/EmailReturnRecipient"
}
},
"error": {
"type": "string",
"description": "Error message associated with the email, if any."
},
"subject": {
"type": "string",
"description": "Subject line of the email."
},
"attachmentCount": {
"type": "integer",
"description": "Number of attachments in the email."
},
"expirationDate": {
"type": "string",
"format": "date",
"description": "Expiration date of the email package, if applicable."
},
"avStatus": {
"type": "string",
"description": "Antivirus (AV) scan status of the email."
},
"dlpStatus": {
"type": "string",
"description": "Data Loss Prevention (DLP) scan status of the email."
},
"hasTrackingAccess": {
"type": "boolean",
"description": "Indicates if tracking access is enabled for the email."
},
"trackingAccess": {
"description": "List of recipients with tracking access.",
"type": "array",
"items": {
"$ref": "#/components/schemas/TrackingAccessRecipient"
}
},
"policyDirective": {
"type": "integer",
"description": "Indicates the restriction type applied to the email"
},
"isRead": {
"type": "boolean",
"description": "Indicates if the email has been read."
},
"bucket": {
"type": "string",
"description": "The bucket where the email is stored. (e.g. inbox, sent, trash)"
},
"body": {
"type": "string",
"description": "The body of the email."
},
"package": {
"description": "Details of the associated email package.",
"allOf": [
{
"$ref": "#/components/schemas/Package"
}
]
},
"rawBody": {
"type": "string",
"description": "Raw email body content without HTML markup."
},
"headline": {
"type": "string",
"description": "Headline or main title of the email."
},
"notice": {
"type": "string",
"description": "Notice part of the email."
},
"fullHtmlBody": {
"type": "string",
"description": "Full HTML body of the email."
},
"emailFrom": {
"type": "string",
"description": "The email address from which the email was sent."
},
"templateBody": {
"type": "string",
"description": "Body content generated from the email template."
},
"webFormId": {
"type": "string",
"description": "Unique identifier of the web form associated with the email."
},
"webFormFields": {
"description": "Fields included in the associated web form with the mail."
},
"sender": {
"description": "Details of the sender.",
"allOf": [
{
"$ref": "#/components/schemas/UserBasic"
}
]
},
"sharedMailboxId": {
"type": "string",
"description": "Unique identifier of the shared mailbox, if applicable."
},
"htmlBody": {
"type": "string",
"description": "HTML version of the email body."
},
"actor": {
"description": "The user responsible for sending the email, applicable when the email is sent on behalf of a shared mailbox.",
"allOf": [
{
"$ref": "#/components/schemas/UserBasic"
}
]
},
"darkModeStyle": {
"type": "string",
"description": "CSS styles applied for dark mode."
},
"exists": {
"type": "boolean",
"description": "Indicates whether the email already exists in the system."
}
}
},
"Mails": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Mail1"
}
},
"metadata": {
"$ref": "#/components/schemas/MetaData"
}
}
},
"MailCounters": {
"type": "object",
"properties": {
"draft": {
"type": "integer",
"description": "Number of draft emails."
},
"inbox": {
"type": "integer",
"description": "Number of emails in the inbox."
},
"inboxUnread": {
"type": "integer",
"description": "Number of unread emails in the inbox."
},
"outgoing": {
"type": "integer",
"description": "Number of outgoing emails."
},
"outgoingError": {
"type": "integer",
"description": "Number of outgoing emails that encountered an error."
},
"outgoingQueued": {
"type": "integer",
"description": "Number of outgoing emails queued for sending."
},
"outgoingTransferring": {
"type": "integer",
"description": "Number of outgoing emails currently being transferred."
},
"outgoingTransferringIds": {
"type": "array",
"items": {
"type": "string"
}
},
"trash": {
"type": "integer",
"description": "Number of emails in the trash."
}
}
},
"MailWithdrawRequest": {
"type": "object",
"properties": {
"ids": {
"type": "array",
"description": "List of email UUIDs to withdraw. Withdrawing an email revokes recipient access to its attachments.",
"items": {
"type": "string"
}
}
},
"required": [
"ids"
]
},
"ErrorInteger": {
"type": "object",
"properties": {
"code": {
"type": "string",
"description": "Error code"
},
"message": {
"type": "string",
"description": "Error message"
},
"field": {
"type": "string",
"description": "Associated field, if applicable."
},
"failedIds": {
"type": "array",
"description": "List of failed IDs.",
"items": {
"type": "integer"
}
}
}
},
"BulkOperationInteger": {
"type": "object",
"properties": {
"errors": {
"description": "List of errors",
"type": "array",
"items": {
"$ref": "#/components/schemas/ErrorInteger"
}
},
"successIds": {
"type": "array",
"description": "List of succeeded IDs.",
"items": {
"type": "integer"
}
}
}
},
"Attachments": {
"type": "object",
"properties": {
"data": {
"description": "List of attachments.",
"type": "array",
"items": {
"$ref": "#/components/schemas/Attachment"
}
},
"metadata": {
"description": "Pagination metadata for the result set.",
"allOf": [
{
"$ref": "#/components/schemas/MetaData"
}
]
}
}
},
"SendMailSettingPutRequest": {
"type": "object",
"properties": {
"trackingAccess": {
"type": "array",
"description": "List of email addresses to grant access to the email's download tracking dashboard.",
"items": {
"type": "string",
"format": "email"
}
}
}
},
"RecentObject": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "UUID of the recently accessed file or folder."
},
"lastAccessed": {
"type": "string",
"format": "date",
"description": "Timestamp of when the object was last accessed by the user."
}
},
"required": [
"id",
"lastAccessed"
]
},
"RecentObjectsPostRequest": {
"type": "object",
"properties": {
"objects": {
"type": "array",
"description": "List of recently accessed objects to record, each containing an object UUID and last-accessed timestamp.",
"items": {
"$ref": "#/components/schemas/RecentObject"
}
}
},
"required": [
"objects"
]
},
"SystemFolders": {
"type": "object",
"properties": {
"current_num_sys_folders": {
"type": "integer",
"description": "Current number of system folders."
},
"max_num_sys_folders": {
"type": "integer",
"description": "Maximum allowed number of system folders."
},
"per_folder_quota_options": {
"type": "array",
"description": "List of available quota options per folder.",
"items": {
"type": "integer"
}
},
"per_folder_default_quota": {
"type": "integer",
"description": "Default quota assigned to each folder."
}
}
},
"UserQuota": {
"type": "object",
"properties": {
"send_quota_allowed": {
"type": "integer",
"description": "The allowed send quota for the user."
},
"send_quota_used": {
"type": "integer",
"description": "The amount of send quota used by the user."
},
"folder_quota_allowed": {
"type": "integer",
"description": "The allowed folder quota for the user."
},
"folder_quota_used": {
"type": "integer",
"description": "The amount of folder quota used by the user."
},
"sys_folders": {
"description": "Details of the system folders quota.",
"allOf": [
{
"$ref": "#/components/schemas/SystemFolders"
}
]
}
}
},
"UserMePinsPostRequest": {
"type": "object",
"properties": {
"ids": {
"type": "array",
"description": "List of entity IDs to pin or unpin.",
"items": {
"type": "string"
}
},
"type": {
"type": "string",
"description": "The type of entity being pinned or unpinned.
`source` \u2013 An external content source."
}
},
"required": [
"ids",
"type"
]
},
"UserDistributionList": {
"type": "object",
"properties": {
"email": {
"type": "string",
"description": "Email address of the distribution list or individual contact."
},
"isDl": {
"type": "boolean",
"description": "Indicates whether the entry is a distribution list."
}
}
},
"UserDistributionLists": {
"type": "object",
"properties": {
"data": {
"description": "List of distribution list entries.",
"type": "array",
"items": {
"$ref": "#/components/schemas/UserDistributionList"
}
}
}
},
"UserMeConcurrentChallenge": {
"type": "object",
"properties": {
"created": {
"type": "string",
"format": "date"
},
"userAgent": {
"type": "string"
},
"location": {
"type": "string"
}
}
},
"UserMeConcurrentAuthPostRequest": {
"type": "object",
"properties": {
"terminate": {
"type": "boolean",
"description": "If true, terminates the existing concurrent session and proceeds with the current login. If false, cancels the current login attempt."
},
"referral": {
"type": "string",
"description": "The referral token from the concurrent session challenge, used to identify the session to terminate."
}
},
"required": [
"referral",
"terminate"
]
},
"RequestFileToInboxPostRequest": {
"type": "object",
"properties": {
"to": {
"type": "array",
"description": "List of email addresses to send the files to.",
"items": {
"type": "string",
"format": "email"
}
},
"subject": {
"type": "string",
"minLength": 1,
"maxLength": 998,
"description": "Subject of the email. Must be between 1 and 998 characters."
},
"body": {
"type": "string",
"description": "The body of the email."
},
"expire": {
"type": "string",
"format": "date",
"description": "The expiration date of the request file link."
},
"fileLimit": {
"type": "integer",
"minimum": 0,
"description": "The maximum number of files to attach."
},
"requireAuth": {
"type": "boolean",
"description": "Indicates if authentication is required to access the files."
},
"returnReceipts": {
"type": "array",
"description": "List of email addresses to send read receipts to.",
"items": {
"type": "string",
"format": "email"
}
},
"sharedMailboxId": {
"type": "string",
"description": "Unique identifier for the Shared Mailbox. Used to search for results belonging to this Shared Mailbox."
}
},
"required": [
"subject",
"to"
]
},
"RequestFileToFolderPostRequest": {
"type": "object",
"properties": {
"to": {
"type": "array",
"description": "List of email addresses to send the files to.",
"items": {
"type": "string",
"format": "email"
}
},
"subject": {
"type": "string",
"minLength": 1,
"maxLength": 998,
"description": "Subject of the email. Must be between 1 and 998 characters."
},
"body": {
"type": "string",
"description": "The body of the email."
},
"expire": {
"type": "string",
"format": "date",
"description": "The expiration date of the request file link."
},
"count": {
"type": "integer",
"minimum": 0,
"description": "The maximum number of files to attach."
},
"requireAuth": {
"type": "boolean",
"description": "Indicates if authentication is required to access the files."
},
"files": {
"type": "array",
"description": "List of object GUIDs representing the files to be sent.",
"items": {
"type": "string"
}
},
"actionId": {
"type": "integer",
"minimum": 1,
"maximum": 2,
"description": "The action to allow recipients to perform on viewable files.
`1` \u2013 View only.
`2` \u2013 View and download."
},
"showToken": {
"type": "integer",
"minimum": 0,
"maximum": 1,
"description": "Whether to include the request file token in the response.
`0` \u2013 Do not include the token.
`1` \u2013 Include the token."
}
},
"required": [
"subject",
"to"
]
},
"UserBasic1": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique identifier (UUID) for the user."
},
"email": {
"type": "string",
"description": "Email address associated with the user."
}
}
},
"Mail2": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique identifier of the email."
},
"subject": {
"type": "string",
"description": "Subject line of the email."
},
"body": {
"type": "string",
"description": "The body of the email."
},
"fullHtmlBody": {
"type": "string",
"description": "Full HTML body of the email."
},
"parentEmailId": {
"type": "string",
"description": "Unique identifier of the parent email, if applicable."
},
"emailPackageId": {
"type": "string",
"description": "Unique identifier of the associated email package."
},
"senderId": {
"type": "string",
"description": "Unique identifier of the sender."
},
"sharedMailboxId": {
"type": "string",
"description": "Unique identifier of the shared mailbox, if applicable."
}
}
},
"RequestFileConfig": {
"type": "object",
"properties": {
"excludedFileExtensions": {
"type": "array",
"description": "List of file extensions not allowed for upload via this file request.",
"items": {
"type": "string"
}
}
}
},
"RequestFileReplyPostRequest": {
"type": "object",
"properties": {
"body": {
"type": "string",
"description": "The body of the reply. This field is optional."
}
}
},
"Folder1": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"description": "Unique identifier (UUID) of the folder."
},
"parentId": {
"type": "string",
"format": "uuid",
"description": "Unique identifier (UUID) of the parent object."
},
"name": {
"type": "string",
"description": "Name of the object."
},
"type": {
"type": "string",
"description": "Type of the object.
`f` \u2013 File.
`d` \u2013 Folder."
},
"userId": {
"type": "string",
"format": "uuid",
"description": "Unique identifier (UUID) who created the folder."
},
"creator": {
"description": "Details of the user who created the object.",
"allOf": [
{
"$ref": "#/components/schemas/UserBasic"
}
]
},
"created": {
"type": "string",
"format": "date",
"description": "The date and time when the object was created."
},
"modified": {
"type": "string",
"format": "date",
"description": "The date and time when the object was last modified."
},
"expire": {
"type": "string",
"format": "date",
"description": "Expiration timestamp of the object, if applicable."
},
"permissions": {
"description": "List of permissions associated with the object.",
"type": "array",
"items": {
"$ref": "#/components/schemas/Permission"
}
},
"deleted": {
"type": "boolean",
"description": "Indicates whether the object has been deleted."
},
"permDeleted": {
"type": "boolean",
"description": "Indicates whether the object has been permanently deleted."
},
"permalink": {
"type": "string",
"description": "Permanent URL link to access the object."
},
"path": {
"type": "string",
"description": "Path to the folder in the hierarchy."
},
"members": {
"description": "List of members who have access to the object.",
"type": "array",
"items": {
"$ref": "#/components/schemas/Member"
}
},
"vendorDocId": {
"type": "string",
"description": "Vendor document ID associated with the object."
},
"vendorDocName": {
"type": "string",
"description": "Name of the vendor document associated with the object."
},
"secure": {
"type": "boolean",
"description": "Indicates whether the folder or the parent folder containing the file is marked as secure."
},
"source": {
"type": "integer",
"description": "ID representing the source of the object (1 - Salesforce, 2 - Teams)."
},
"isShared": {
"type": "boolean",
"description": "Indicates if the folder is shared with other users."
},
"syncable": {
"type": "boolean",
"description": "Indicates if the folder can be synced by Desktop Sync Client."
},
"fileLifetime": {
"type": "integer",
"description": "Time duration (in days) for which the files in this folder are kept after being added to the folder."
},
"description": {
"type": "string",
"description": "The description of the folder."
},
"parent": {
"description": "The parent folder of the current folder.",
"allOf": [
{
"$ref": "#/components/schemas/Folder"
}
]
},
"isFavorite": {
"type": "boolean",
"description": "Indicates if the folder is marked as a favorite by the user."
},
"pushedFilesCount": {
"type": "integer",
"description": "The number of files that have been pushed to mobile apps in this folder."
},
"currentUserRole": {
"description": "The role of the current user in this folder.",
"allOf": [
{
"$ref": "#/components/schemas/Role"
}
]
},
"avStatus": {
"type": "string",
"description": "The Antivirus (AV) status of the folder."
},
"dlpStatus": {
"type": "string",
"description": "The Data Loss Prevention (DLP) status of the folder."
},
"totalMembersCount": {
"type": "integer",
"description": "Total number of members who have access to this folder."
},
"totalFoldersCount": {
"type": "integer",
"description": "Total number of subfolders within this folder."
},
"totalFilesCount": {
"type": "integer",
"description": "Total number of files within this folder."
},
"maxFolderExpiration": {
"type": "string",
"format": "date",
"description": "The maximum expiration date allowed for files in this folder."
},
"maxFileLifetime": {
"type": "integer",
"description": "The maximum duration (in days) that files in this folder can be kept after being added to the folder."
},
"isLdapGroupMember": {
"type": "boolean",
"description": "Indicates if the folder is part of an LDAP group."
},
"isUnderMyFolder": {
"type": "boolean",
"description": "Indicates if this folder is a subfolder of the user's \"My Folder\"."
},
"pathIds": {
"type": "string",
"description": "A list of IDs representing the path of the folder within the folder hierarchy."
},
"isRoot": {
"type": "boolean",
"description": "Indicates if this folder is a root folder."
},
"rootId": {
"type": "string",
"format": "uuid",
"description": "The ID of the root folder if this is a subfolder."
},
"useFolderQuota": {
"type": "boolean",
"description": "Indicates if a folder quota is applied to this folder."
},
"quota": {
"type": "integer",
"description": "The storage quota for the folder (in bytes)."
},
"size": {
"type": "integer",
"description": "The total storage size used by the folder (in bytes)."
},
"freeSpace": {
"type": "integer",
"description": "The amount of free space available in the folder (in bytes)."
},
"inheritanceEnabled": {
"type": "boolean",
"description": "Indicates if a folder inherits permissions from the parent folder"
}
}
},
"MultipleFolderIdRequest": {
"type": "object",
"properties": {
"folderIds": {
"type": "array",
"description": "A list of folder IDs to be processed.",
"items": {
"type": "string"
}
},
"destinationFolderId": {
"type": "string",
"description": "The destination folder"
}
},
"required": [
"destinationFolderId",
"folderIds"
]
},
"ErrorString": {
"type": "object",
"properties": {
"code": {
"type": "string",
"description": "Error code"
},
"message": {
"type": "string",
"description": "Error message"
},
"field": {
"type": "string",
"description": "Associated field, if applicable."
},
"failedIds": {
"type": "array",
"description": "List of failed IDs.",
"items": {
"type": "string"
}
}
}
},
"BulkOperationMoveFolders": {
"type": "object",
"properties": {
"errors": {
"description": "List of errors.",
"type": "array",
"items": {
"$ref": "#/components/schemas/ErrorString"
}
},
"successIds": {
"type": "array",
"description": "List of successfully moved folder IDs.",
"items": {
"type": "string"
}
},
"data": {
"description": "Details of moved folders.",
"type": "array",
"items": {
"$ref": "#/components/schemas/Folder1"
}
}
}
},
"FolderQuota": {
"type": "object",
"properties": {
"quota_allowance": {
"type": "integer",
"description": "Quota allowance allocated to the folder in bytes."
},
"storage_available": {
"type": "integer",
"description": "Storage available for the folder in bytes."
},
"storage_quota": {
"type": "integer",
"description": "Total storage quota assigned to the folder in bytes."
},
"storage_used": {
"type": "integer",
"description": "Storage currently used by the folder in bytes."
},
"folder_size": {
"type": "integer",
"description": "Total size of all files in the folder in bytes."
},
"owner_sys_folder_quota_options": {
"type": "array",
"description": "List of available quota option values (in bytes) for system folders.",
"items": {
"type": "integer"
}
}
}
},
"FolderMemberPostRequest": {
"type": "object",
"properties": {
"notify": {
"type": "boolean",
"description": "If set to `true`, notifies the user being invited to the folder via email."
},
"emails": {
"type": "array",
"description": "List of email addresses for new members.",
"items": {
"type": "string",
"format": "email"
}
},
"userIds": {
"type": "array",
"description": "List of user IDs for new members.",
"items": {
"type": "string"
}
},
"ldapGroupIds": {
"type": "array",
"description": "List of LDAP group IDs for new members.",
"items": {
"type": "integer"
}
},
"roleId": {
"type": "integer",
"description": "The role ID to assign to the new members."
},
"notifyFileAdded": {
"type": "boolean",
"description": "If set to `true`, subscribes the user to notifications for file additions."
}
},
"required": [
"roleId"
]
},
"RiskPolicy": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Risk Policy ID"
},
"parentId": {
"type": "integer",
"description": "Unique identifier of the parent object."
},
"name": {
"type": "string",
"description": "Risk Policy Name"
},
"type": {
"type": "string",
"description": "Type of the object.
`f` \u2013 File.
`d` \u2013 Folder."
},
"userId": {
"type": "string",
"format": "uuid",
"description": "Unique identifier (UUID) who created the object."
},
"creator": {
"description": "Details of the user who created the object.",
"allOf": [
{
"$ref": "#/components/schemas/UserBasic"
}
]
},
"created": {
"type": "string",
"format": "date",
"description": "The date and time when the object was created."
},
"modified": {
"type": "string",
"format": "date",
"description": "The date and time when the object was last modified."
},
"expire": {
"type": "string",
"format": "date",
"description": "Expiration timestamp of the object, if applicable."
},
"permissions": {
"description": "List of permissions associated with the object.",
"type": "array",
"items": {
"$ref": "#/components/schemas/Permission"
}
},
"deleted": {
"type": "boolean",
"description": "Indicates whether the object has been deleted."
},
"permDeleted": {
"type": "boolean",
"description": "Indicates whether the object has been permanently deleted."
},
"permalink": {
"type": "string",
"description": "Permanent URL link to access the object."
},
"path": {
"type": "string",
"description": "Path to the object in the hierarchy."
},
"members": {
"description": "List of members who have access to the object.",
"type": "array",
"items": {
"$ref": "#/components/schemas/Member"
}
},
"vendorDocId": {
"type": "string",
"description": "Vendor document ID associated with the object."
},
"vendorDocName": {
"type": "string",
"description": "Name of the vendor document associated with the object."
},
"secure": {
"type": "boolean",
"description": "Indicates whether the folder or the parent folder containing the file is marked as secure."
},
"source": {
"type": "integer",
"description": "ID representing the source of the object (1 - Salesforce, 2 - Teams)."
},
"message": {
"type": "string",
"description": "Risk Policy Message"
}
}
},
"Requirement": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Requirement ID"
},
"parentId": {
"type": "integer",
"description": "Unique identifier of the parent object."
},
"name": {
"type": "string",
"description": "Name of the object."
},
"type": {
"type": "string",
"description": "Type of the object.
`f` \u2013 File.
`d` \u2013 Folder."
},
"userId": {
"type": "string",
"format": "uuid",
"description": "Unique identifier (UUID) who created the object."
},
"creator": {
"description": "Details of the user who created the object.",
"allOf": [
{
"$ref": "#/components/schemas/UserBasic"
}
]
},
"created": {
"type": "string",
"format": "date",
"description": "The date and time when the object was created."
},
"modified": {
"type": "string",
"format": "date",
"description": "The date and time when the object was last modified."
},
"expire": {
"type": "string",
"format": "date",
"description": "Expiration timestamp of the object, if applicable."
},
"permissions": {
"description": "List of permissions associated with the object.",
"type": "array",
"items": {
"$ref": "#/components/schemas/Permission"
}
},
"deleted": {
"type": "boolean",
"description": "Indicates whether the object has been deleted."
},
"permDeleted": {
"type": "boolean",
"description": "Indicates whether the object has been permanently deleted."
},
"permalink": {
"type": "string",
"description": "Permanent URL link to access the object."
},
"path": {
"type": "string",
"description": "Path to the object in the hierarchy."
},
"members": {
"description": "List of members who have access to the object.",
"type": "array",
"items": {
"$ref": "#/components/schemas/Member"
}
},
"vendorDocId": {
"type": "string",
"description": "Vendor document ID associated with the object."
},
"vendorDocName": {
"type": "string",
"description": "Name of the vendor document associated with the object."
},
"secure": {
"type": "boolean",
"description": "Indicates whether the folder or the parent folder containing the file is marked as secure."
},
"source": {
"type": "integer",
"description": "ID representing the source of the object (1 - Salesforce, 2 - Teams)."
},
"approvers": {
"description": "List of approvers for the requirement"
},
"asset_class": {
"description": "Asset class associated with the requirement",
"allOf": [
{
"$ref": "#/components/schemas/RiskPolicy"
}
]
},
"matched_recipients": {
"type": "array",
"description": "List of succeeded recipient emails.",
"items": {
"type": "string"
}
}
}
},
"AccessVerificationApproval": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Access Verification ID"
},
"parentId": {
"type": "integer",
"description": "Unique identifier of the parent object."
},
"name": {
"type": "string",
"description": "Name of the object."
},
"type": {
"type": "string",
"description": "Type of the object.
`f` \u2013 File.
`d` \u2013 Folder."
},
"userId": {
"type": "string",
"format": "uuid",
"description": "Unique identifier (UUID) who created the object."
},
"creator": {
"description": "Details of the user who created the object.",
"allOf": [
{
"$ref": "#/components/schemas/UserBasic"
}
]
},
"created": {
"type": "string",
"format": "date",
"description": "The date and time when the object was created."
},
"modified": {
"type": "string",
"format": "date",
"description": "The date and time when the object was last modified."
},
"expire": {
"type": "string",
"format": "date",
"description": "Expiration timestamp of the object, if applicable."
},
"permissions": {
"description": "List of permissions associated with the object.",
"type": "array",
"items": {
"$ref": "#/components/schemas/Permission"
}
},
"deleted": {
"type": "boolean",
"description": "Indicates whether the object has been deleted."
},
"permDeleted": {
"type": "boolean",
"description": "Indicates whether the object has been permanently deleted."
},
"permalink": {
"type": "string",
"description": "Permanent URL link to access the object."
},
"path": {
"type": "string",
"description": "Path to the object in the hierarchy."
},
"members": {
"description": "List of members who have access to the object.",
"type": "array",
"items": {
"$ref": "#/components/schemas/Member"
}
},
"vendorDocId": {
"type": "string",
"description": "Vendor document ID associated with the object."
},
"vendorDocName": {
"type": "string",
"description": "Name of the vendor document associated with the object."
},
"secure": {
"type": "boolean",
"description": "Indicates whether the folder or the parent folder containing the file is marked as secure."
},
"source": {
"type": "integer",
"description": "ID representing the source of the object (1 - Salesforce, 2 - Teams)."
},
"requirements": {
"type": "array",
"description": "List of requirements for access verification",
"items": {
"$ref": "#/components/schemas/Requirement"
}
}
}
},
"ErrorStringSchemaAccessVerifications": {
"type": "object",
"properties": {
"code": {
"type": "string",
"description": "Error code"
},
"message": {
"type": "string",
"description": "Error message"
},
"field": {
"type": "string",
"description": "Associated field, if applicable."
},
"failedIds": {
"type": "array",
"description": "List of failed IDs.",
"items": {
"type": "string"
}
},
"accessVerification": {
"description": "Access Verification details",
"allOf": [
{
"$ref": "#/components/schemas/AccessVerificationApproval"
}
]
},
"referenceId": {
"type": "string",
"description": "Reference ID for the error"
}
}
},
"FolderFileAddMembers": {
"type": "object",
"properties": {
"errors": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ErrorStringSchemaAccessVerifications"
}
},
"successIds": {
"type": "array",
"description": "List of succeeded IDs.",
"items": {
"type": "string"
}
},
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Member"
}
}
}
},
"BaseError": {
"type": "object",
"properties": {
"code": {
"type": "string",
"description": "Error code"
}
}
},
"Errors": {
"type": "object",
"properties": {
"error": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"Members": {
"type": "object",
"properties": {
"data": {
"description": "List of members with access to the object.",
"type": "array",
"items": {
"$ref": "#/components/schemas/Member"
}
},
"metadata": {
"description": "Pagination metadata for the result set.",
"allOf": [
{
"$ref": "#/components/schemas/MetaData"
}
]
}
}
},
"FoldersMetaData": {
"type": "object",
"properties": {
"total": {
"type": "integer",
"description": "Total number of items available."
},
"limit": {
"type": "integer",
"description": "Maximum number of items returned per page."
},
"offset": {
"type": "integer",
"description": "Number of items skipped before the current page."
},
"totalDeletedFoldersCount": {
"type": "integer",
"description": "Total number of deleted folders."
},
"totalDeletedFilesCount": {
"type": "integer",
"description": "Total number of deleted files."
}
}
},
"Folders": {
"type": "object",
"properties": {
"data": {
"description": "List of folders.",
"type": "array",
"items": {
"$ref": "#/components/schemas/Folder1"
}
},
"metadata": {
"description": "Pagination metadata for the result set.",
"allOf": [
{
"$ref": "#/components/schemas/FoldersMetaData"
}
]
}
}
},
"FolderUpdatePutRequest": {
"type": "object",
"properties": {
"name": {
"type": "string",
"maxLength": 255,
"description": "New name for the folder (maximum 255 characters)."
},
"description": {
"type": "string",
"description": "Updated description for the folder."
},
"syncable": {
"type": "boolean",
"description": "Indicates whether the folder can be synced by the Desktop Sync Client. Can only be set on top-level folders."
},
"expire": {
"type": "string",
"format": "date",
"description": "The folder expiration date. Applicable to top-level folders only."
},
"fileLifetime": {
"type": "integer",
"nullable": true,
"minimum": 0,
"description": "Number of days files are retained in this folder before expiring. Set to 0 for no expiration."
},
"applyFileLifetimeToFiles": {
"type": "boolean",
"description": "If true, applies the updated `fileLifetime` setting to all existing files in this folder."
},
"applyFileLifetimeToNested": {
"type": "boolean",
"description": "If true, applies the updated `fileLifetime` setting to all nested subfolders."
},
"secure": {
"type": "boolean",
"description": "Marks the folder as secure, restricting access to authorised recipients only. Can only be set on top-level folders under the user's root folder."
},
"clientId": {
"type": "string",
"description": "Client application identifier used to associate the folder with a specific plugin or integration."
},
"vendorDocId": {
"type": "string",
"description": "External vendor document ID to link this folder to a document in a third-party system."
},
"vendorDocName": {
"type": "string",
"description": "Display name of the linked vendor document."
},
"useFolderQuota": {
"type": "boolean",
"description": "Indicates whether this is a system folder with its own dedicated storage quota."
},
"quota": {
"type": "integer",
"enum": [
1073741824,
2147483648,
5368709120,
10737418240,
53687091200,
-1
],
"description": "Storage quota for the folder in bytes. Must be one of the permitted sizes: 1 GB (1,073,741,824), 2 GB (2,147,483,648), 5 GB (5,368,709,120), 10 GB (10,737,418,240), 50 GB (53,687,091,200), or -1 for unlimited."
},
"breakInheritance": {
"type": "boolean",
"description": "If true, breaks permission inheritance from the parent folder, making this folder's members independent. Only `true` is accepted; passing `false` is invalid."
}
}
},
"FolderCreatePostRequest": {
"type": "object",
"properties": {
"name": {
"type": "string",
"maxLength": 255,
"description": "The name of the new folder (maximum 255 characters)."
},
"secure": {
"type": "boolean",
"description": "Marks the folder as secure, restricting access to authorised recipients only. Can only be set on top-level folders under the user's root folder."
},
"syncable": {
"type": "boolean",
"description": "Indicates whether the folder can be synced by the Desktop Sync Client. Can only be set on top-level folders."
},
"expire": {
"type": "string",
"format": "date",
"description": "The folder expiration date. Applicable to top-level folders only."
},
"fileLifetime": {
"type": "integer",
"nullable": true,
"minimum": 0,
"description": "Number of days files are retained in this folder before expiring. Set to 0 for no expiration. Applicable to top-level folders."
},
"rename": {
"type": "boolean",
"description": "If true, automatically renames the folder if a folder with the same name already exists in the destination."
},
"description": {
"type": "string",
"description": "Optional description for the folder."
},
"clientId": {
"type": "string",
"description": "Client application identifier used to associate the folder with a specific plugin or integration."
},
"vendorDocId": {
"type": "string",
"nullable": true,
"description": "External vendor document ID to link this folder to a document in a third-party system."
},
"vendorDocName": {
"type": "string",
"nullable": true,
"description": "Display name of the linked vendor document."
},
"isFolderUpload": {
"type": "boolean",
"description": "Indicates whether this folder is being created as part of a folder upload operation. For internal use only."
},
"useFolderQuota": {
"type": "boolean",
"description": "Indicates whether this is a system folder with its own dedicated storage quota."
},
"quota": {
"type": "integer",
"enum": [
1073741824,
2147483648,
5368709120,
10737418240,
53687091200,
-1
],
"description": "Storage quota for the folder in bytes. Must be one of the permitted sizes: 1 GB (1,073,741,824), 2 GB (2,147,483,648), 5 GB (5,368,709,120), 10 GB (10,737,418,240), 50 GB (53,687,091,200), or -1 for unlimited."
},
"inheritanceEnabled": {
"type": "boolean",
"description": "Indicates whether the folder inherits member permissions from its parent folder."
}
},
"required": [
"name"
]
},
"ActivityUser": {
"type": "object",
"properties": {
"userId": {
"type": "string"
},
"name": {
"type": "string",
"description": "Full name of the user."
},
"email": {
"type": "string",
"description": "Email address associated with the user."
},
"profileIcon": {
"type": "string",
"description": "URL or identifier for the user's profile icon."
}
}
},
"ActivityList": {
"type": "object",
"properties": {
"data": {
"type": "array",
"description": "List of activity events.",
"items": {
"$ref": "#/components/schemas/Activity"
}
}
}
},
"FolderChildrenFiles": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/File"
}
},
"metadata": {
"$ref": "#/components/schemas/MetaData"
}
}
},
"FolderPermissions": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Permission"
}
}
}
},
"FolderSendMessageRequest": {
"type": "object",
"properties": {
"to": {
"type": "array",
"description": "List of recipient user UUIDs (To field).",
"items": {
"type": "string"
}
},
"cc": {
"type": "array",
"description": "List of recipient user UUIDs (CC field).",
"items": {
"type": "string"
}
},
"bcc": {
"type": "array",
"description": "List of recipient user UUIDs (BCC field).",
"items": {
"type": "string"
}
},
"secureBody": {
"type": "boolean",
"description": "If true, the message body is hidden from the notification email and is only visible to recipients when they open the secure link."
},
"body": {
"type": "string",
"description": "The body content of the email."
},
"subject": {
"type": "string",
"maxLength": 998,
"description": "The subject of the email (maximum length: 998 characters)."
}
},
"required": [
"subject"
]
},
"Logout": {
"type": "object",
"properties": {
"redirectUri": {
"type": "string",
"description": "URL to redirect to after logout."
}
}
},
"FileMembersPostRequest": {
"type": "object",
"properties": {
"notify": {
"type": "boolean",
"description": "If set to `true`, notifies the user being invited to the file via email."
},
"emails": {
"type": "array",
"description": "List of email addresses for new members.",
"items": {
"type": "string",
"format": "email"
}
},
"userIds": {
"type": "array",
"description": "List of user IDs (UUID) for new members. (Recommended request size <= 100)",
"items": {
"type": "string"
}
},
"ids": {
"type": "array",
"description": "List of file UUIDs to share with the specified users.",
"items": {
"type": "string"
}
},
"roleId": {
"type": "integer",
"enum": [
8,
9
],
"description": "The role to assign to the new members.
`8` \u2013 Collaborator (can upload, edit, and download).
`9` \u2013 Viewer (read-only access)."
},
"message": {
"type": "string",
"description": "Optional message to include with the file sharing."
}
},
"required": [
"roleId"
]
},
"FilePreviewSupport": {
"type": "object",
"properties": {
"supportedIds": {
"type": "array",
"description": "Unique identifier (UUID) of the supported files",
"items": {
"type": "string"
}
}
}
},
"PostFileZipStatusBodyRequest": {
"type": "object",
"properties": {
"fileIds": {
"type": "array",
"maxItems": 1000,
"description": "List of file UUIDs to include in the bulk download. Maximum 1000 entries.",
"items": {
"type": "string"
}
},
"folderIds": {
"type": "array",
"maxItems": 100,
"description": "List of folder UUIDs to include in the bulk download. Maximum 100 entries.",
"items": {
"type": "string"
}
},
"fileId": {
"type": "string",
"description": "UUID of a single file to download. Use this for single-file downloads instead of `fileIds`."
},
"versionId": {
"type": "string",
"description": "The version ID of the specified file."
}
}
},
"DownloadLink": {
"type": "object",
"properties": {
"downloadLinks": {
"type": "array",
"description": "List of download URLs for the requested files.",
"items": {
"type": "string"
}
}
}
},
"FileLockPostRequest": {
"type": "object",
"properties": {
"ids": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "A list of file object IDs to be locked/unlocked."
}
}
},
"BulkOperationLockFile": {
"type": "object",
"properties": {
"errors": {
"description": "List of errors for files that could not be locked.",
"type": "array",
"items": {
"$ref": "#/components/schemas/ErrorString"
}
},
"successIds": {
"type": "array",
"description": "List of IDs for successfully locked files.",
"items": {
"type": "string"
}
},
"data": {
"description": "List of file objects that were successfully locked.",
"type": "array",
"items": {
"$ref": "#/components/schemas/File"
}
}
}
},
"FileUpdateRequest": {
"type": "object",
"properties": {
"name": {
"type": "string",
"maxLength": 255,
"description": "The new name for the file."
},
"expire": {
"type": "string",
"format": "date",
"description": "The updated expiration date for the file."
},
"replace": {
"type": "boolean",
"description": "Indicates whether to replace the existing file if one with the same name already exists."
}
}
},
"FileMovePostBodyRequest": {
"type": "object",
"properties": {
"ids": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "List of file UUIDs to move. Cannot be used together with `id:in` in the query string."
},
"destinationFolderId": {
"type": "string",
"description": "UUID of the destination folder to move the files into."
},
"replace": {
"type": "boolean",
"description": "If true, overwrites existing files in the destination folder if they share the same name."
}
},
"required": [
"destinationFolderId"
]
},
"FileCopyPostBodyRequest": {
"type": "object",
"properties": {
"ids": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "List of file UUIDs to copy. Cannot be used together with `id:in` in the query string."
},
"destinationFolderId": {
"type": "string",
"description": "UUID of the destination folder to copy the files into."
},
"replace": {
"type": "boolean",
"description": "If true, overwrites existing files in the destination folder if they share the same name."
},
"newFileName": {
"type": "string",
"maxLength": 255,
"description": "New name for the copied file. Only applicable when copying a single file into the same folder to avoid a name conflict."
}
},
"required": [
"destinationFolderId"
]
},
"ExternalDLUpdateRequest": {
"type": "object",
"properties": {
"emails": {
"type": "array",
"description": "List of email addresses to add or remove from the external distribution lists.",
"items": {
"type": "string",
"format": "email"
}
}
},
"required": [
"emails"
]
},
"ExternalDL": {
"type": "object",
"properties": {
"email": {
"type": "string",
"description": "Email address of the external distribution list entry."
}
}
},
"ExternalDLs": {
"type": "object",
"properties": {
"data": {
"description": "List of external distribution list entries.",
"type": "array",
"items": {
"$ref": "#/components/schemas/ExternalDL"
}
}
}
},
"Sources": {
"type": "object",
"properties": {
"data": {
"description": "List of external content sources.",
"type": "array",
"items": {
"$ref": "#/components/schemas/Source"
}
}
}
},
"Site": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Display name of the SharePoint site."
},
"isAdded": {
"type": "boolean",
"description": "Indicates whether the site has already been added as an external content source."
},
"url": {
"type": "string",
"description": "URL of the SharePoint site."
},
"ecmTypeId": {
"type": "string",
"description": "External content management type identifier."
},
"repository": {
"type": "string",
"description": "Repository identifier within the SharePoint site."
},
"id": {
"type": "string",
"description": "Unique identifier of the SharePoint site."
}
}
},
"SearchSharePointSitesResult": {
"type": "object",
"properties": {
"sites": {
"type": "array",
"description": "List of SharePoint sites matching the search query.",
"items": {
"$ref": "#/components/schemas/Site"
}
}
}
},
"MobileSyncList": {
"type": "object",
"properties": {
"data": {
"description": "List of mobile sync items.",
"type": "array",
"items": {
"$ref": "#/components/schemas/MobileSync"
}
},
"metadata": {
"description": "Pagination metadata for the result set.",
"allOf": [
{
"$ref": "#/components/schemas/MetaData"
}
]
}
}
},
"FavoriteOpenAPI2": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "Unique identifier of the favorite entry."
},
"userId": {
"type": "string"
},
"objectId": {
"type": "string",
"format": "uuid",
"description": "Unique identifier (UUID) of the favorited object."
},
"object": {
"description": "Details of the favorited object (folder or external content folder).",
"allOf": [
{
"$ref": "#/components/schemas/Folder1"
}
]
}
}
},
"FavoriteListOpenAPI2": {
"type": "object",
"properties": {
"data": {
"description": "List of favorite entries.",
"type": "array",
"items": {
"$ref": "#/components/schemas/FavoriteOpenAPI2"
}
},
"metadata": {
"description": "Pagination metadata for the result set.",
"allOf": [
{
"$ref": "#/components/schemas/MetaData"
}
]
}
}
},
"SharedMailboxMemberStatusPatchRequest": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The UUID of the shared mailbox user."
},
"active": {
"type": "boolean",
"description": "The new active status for the shared mailbox."
}
},
"required": [
"active",
"id"
]
},
"SharedMailboxStatusPatchRequest": {
"type": "object",
"properties": {
"data": {
"description": "List of shared mailbox status updates to apply.",
"type": "array",
"items": {
"$ref": "#/components/schemas/SharedMailboxMemberStatusPatchRequest"
}
}
},
"required": [
"data"
]
},
"SharedMailbox": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"active": {
"type": "boolean",
"description": "Indicates whether the shared mailbox is active."
},
"user": {
"description": "Details of the shared mailbox user account.",
"allOf": [
{
"$ref": "#/components/schemas/UserBasic"
}
]
},
"members": {
"description": "List of users who are members of the shared mailbox.",
"type": "array",
"items": {
"$ref": "#/components/schemas/UserBasic"
}
}
}
},
"SharedMailboxList": {
"type": "object",
"properties": {
"data": {
"description": "List of shared mailboxes.",
"type": "array",
"items": {
"$ref": "#/components/schemas/SharedMailbox"
}
},
"metadata": {
"description": "Pagination metadata for the result set.",
"allOf": [
{
"$ref": "#/components/schemas/MetaData"
}
]
}
}
},
"MailIdCounters": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"counters": {
"description": "Email counters for this mail entity.",
"allOf": [
{
"$ref": "#/components/schemas/MailCounters"
}
]
}
}
},
"MailCountersList": {
"type": "object",
"properties": {
"data": {
"description": "List of mail counter entries.",
"type": "array",
"items": {
"$ref": "#/components/schemas/MailIdCounters"
}
}
}
},
"SendOption": {
"type": "object",
"properties": {
"linkExpiry": {
"type": "boolean",
"description": "Indicates whether link expiry is enabled for sent files."
},
"ACL": {
"type": "integer",
"description": "Access control level applied to sent files."
}
}
},
"SharedMailboxSetting": {
"type": "object",
"properties": {
"fileFilterExclusionGroups": {
"type": "array",
"description": "List of file type groups excluded from upload.",
"items": {
"type": "string"
}
},
"sendOptionEnabled": {
"description": "Send options available to users when composing emails.",
"allOf": [
{
"$ref": "#/components/schemas/SendOption"
}
]
},
"ACL": {
"type": "array",
"description": "List of access control levels available for the shared mailbox.",
"items": {
"type": "string"
}
},
"maxLinkExpiration": {
"type": "integer",
"description": "Maximum link expiration period in days allowed by policy."
},
"returnReceiptDefault": {
"type": "boolean",
"description": "Indicates whether return receipts are requested by default."
},
"zipLimit": {
"type": "integer",
"description": "Maximum number of files that can be included in a single ZIP download."
},
"sendFileLimit": {
"type": "integer",
"description": "Maximum number of files that can be sent in a single email."
},
"selfCopy": {
"type": "string",
"description": "Policy for sending a copy of outgoing emails to the sender."
},
"defaultLinkExpiry": {
"type": "integer",
"description": "Default link expiration period in days."
},
"aclDefault": {
"type": "string",
"description": "Default access control level applied to new files."
},
"fileFilterCustomFileTypes": {
"type": "array",
"description": "List of custom file extensions excluded from upload.",
"items": {
"type": "string"
}
},
"watermarkEnabled": {
"type": "boolean",
"description": "Indicates whether document watermarking is enabled."
},
"returnReceipt": {
"type": "string",
"description": "Policy for requesting read receipts on sent emails."
},
"mailExpirationNotification": {
"type": "string",
"description": "Policy for sending email expiration notifications."
},
"includeFingerprintDefault": {
"type": "boolean",
"description": "Indicates whether fingerprint inclusion is enabled by default."
},
"includeFingerprint": {
"type": "string",
"description": "Policy for including a digital fingerprint in sent emails."
},
"secureMessageBody": {
"type": "string",
"description": "Policy for securing the message body in outgoing emails."
},
"selfCopyDefault": {
"type": "boolean",
"description": "Indicates whether self-copy is enabled by default."
},
"allowedFileExtensions": {
"type": "array",
"description": "List of file extensions explicitly allowed for upload.",
"items": {
"type": "string"
}
},
"excludedFileExtensions": {
"type": "array",
"description": "List of file extensions blocked from upload.",
"items": {
"type": "string"
}
},
"secureMessageBodyDefault": {
"type": "boolean",
"description": "Indicates whether secure message body is enabled by default."
},
"watermarkPreview": {
"type": "string",
"description": "Watermark text or template applied to file previews."
},
"sendExternal": {
"type": "boolean",
"description": "Indicates whether users can send files to external recipients."
},
"defaultForm": {
"type": "string",
"description": "Identifier of the default web form associated with the shared mailbox."
},
"defaultCountryCode": {
"type": "string",
"description": "Default country code used for phone number formatting."
}
}
},
"WebFormList": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/WebForm"
}
}
}
},
"UserSshPublicKeysPostCreateRequest": {
"type": "object",
"properties": {
"name": {
"type": "string",
"maxLength": 50,
"description": "The display name for the SSH public key (maximum 50 characters)."
},
"publicKey": {
"type": "string",
"description": "The SSH public key string to register."
}
},
"required": [
"name",
"publicKey"
]
},
"UserSshPublicKeysPostGenerateRequest": {
"type": "object",
"properties": {
"name": {
"type": "string",
"maxLength": 50,
"description": "The display name for the SSH public key (maximum 50 characters)."
},
"passphrase": {
"type": "string",
"description": "Optional passphrase to protect the generated private key."
}
},
"required": [
"name"
]
},
"UserGeneratedSshPublicKeyKey": {
"type": "object",
"properties": {
"privateKey": {
"type": "string",
"description": "Generated SSH private key."
},
"publicKey": {
"type": "string",
"description": "Generated SSH public key."
}
}
},
"UserSshPublicKey": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "Unique identifier of the SSH public key."
},
"userId": {
"type": "string"
},
"publicKey": {
"type": "string",
"description": "SSH public key string."
},
"name": {
"type": "string",
"description": "Display name for the SSH public key."
},
"active": {
"type": "boolean",
"description": "Indicates whether the SSH public key is active and can be used for authentication."
},
"adminActive": {
"type": "boolean",
"description": "Indicates whether an administrator has enabled this SSH public key."
}
}
},
"UserSshPublicKeyList": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/UserSshPublicKey"
}
}
}
},
"ContactEmail": {
"type": "object",
"properties": {
"email": {
"type": "string",
"format": "email",
"description": "Email address of the contact."
}
},
"required": [
"email"
]
},
"ContactCreate": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Display name for the contact."
},
"items": {
"type": "array",
"minItems": 1,
"description": "List of email addresses associated with this contact. At least one email address is required.",
"items": {
"$ref": "#/components/schemas/ContactEmail"
}
}
},
"required": [
"name"
]
},
"ContactList": {
"type": "object",
"properties": {
"metadata": {
"description": "Pagination metadata for the result set.",
"allOf": [
{
"$ref": "#/components/schemas/MetaData"
}
]
},
"data": {
"type": "array",
"description": "List of contacts.",
"items": {
"$ref": "#/components/schemas/Contact"
}
}
}
},
"GroupEmail": {
"type": "object",
"properties": {
"email": {
"type": "string",
"format": "email",
"description": "Email address of the group member."
}
},
"required": [
"email"
]
},
"GroupCreate": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the group."
},
"items": {
"type": "array",
"minItems": 1,
"description": "List of group members, each specified by their email address. At least one member is required.",
"items": {
"$ref": "#/components/schemas/GroupEmail"
}
}
},
"required": [
"items",
"name"
]
},
"ClientEventLogsPostRequest": {
"type": "object",
"properties": {
"created": {
"type": "integer",
"description": "Unix timestamp of when this event was created on the client."
},
"eventName": {
"type": "string",
"description": "The name of the event being logged."
},
"successful": {
"type": "boolean",
"description": "Indicates whether the event completed successfully."
},
"eventId": {
"type": "string",
"description": "The unique identifier for this event on the client side."
},
"data": {
"type": "object",
"description": "Additional event details as a key-value map."
},
"singleLine": {
"type": "string",
"description": "A single-line summary of the event."
}
},
"required": [
"data",
"eventId",
"eventName",
"singleLine",
"successful"
]
},
"BulkClientEventLogsPostRequest": {
"type": "object",
"properties": {
"events": {
"type": "array",
"description": "List of client event log entries to submit.",
"items": {
"$ref": "#/components/schemas/ClientEventLogsPostRequest"
}
}
}
},
"ClientCustomEventLog": {
"type": "object",
"properties": {
"successIds": {
"type": "array",
"description": "List of event IDs successfully logged.",
"items": {
"type": "string"
}
},
"failedIds": {
"type": "array",
"description": "List of event IDs that failed to log.",
"items": {
"type": "string"
}
}
}
},
"SearchResult": {
"type": "object",
"properties": {
"folders": {
"type": "array",
"description": "List of folders matching the search query.",
"items": {
"$ref": "#/components/schemas/Folder1"
}
},
"files": {
"type": "array",
"description": "List of files matching the search query.",
"items": {
"$ref": "#/components/schemas/File"
}
},
"emails": {
"type": "array",
"description": "List of emails matching the search query.",
"items": {
"$ref": "#/components/schemas/Mail"
}
},
"totalFiles": {
"type": "integer",
"description": "Total number of matching files."
},
"totalFolders": {
"type": "integer",
"description": "Total number of matching folders."
},
"totalEmails": {
"type": "integer",
"description": "Total number of matching emails."
},
"emailSuggestions": {
"type": "array",
"description": "List of email address suggestions related to the search query.",
"items": {
"type": "string"
}
},
"fileSuggestions": {
"type": "array",
"description": "List of file name suggestions related to the search query.",
"items": {
"type": "string"
}
},
"fileHighlightings": {
"type": "object",
"description": "Dictionary of file IDs to highlighted text snippets from full-text search."
}
}
},
"ScimMultiValueMobile": {
"type": "object",
"properties": {
"primary": {
"type": "boolean",
"description": "If true, designates this entry as the primary value."
},
"value": {
"type": "string",
"description": "The phone number value."
},
"type": {
"type": "string",
"description": "The type of phone number (e.g., `mobile`, `work`, `home`)."
}
},
"required": [
"type",
"value"
]
},
"ScimMultiValue": {
"type": "object",
"properties": {
"value": {
"type": "string",
"pattern": "^[A-Za-z0-9 _-]+$",
"description": "The value of the multi-valued attribute."
}
}
},
"ScimUsersPostRequest": {
"type": "object",
"properties": {
"schemas": {
"type": "array",
"minItems": 1,
"description": "List of SCIM schema URNs applicable to this resource. Must include `urn:ietf:params:scim:schemas:core:2.0:User`.",
"items": {
"type": "string"
}
},
"password": {
"type": "string",
"description": "The user's password."
},
"displayName": {
"type": "string",
"pattern": "^[^<>]+$",
"description": "The user's display name. Must not contain `<` or `>` characters."
},
"userType": {
"type": "string",
"pattern": "^[A-Za-z0-9_-]+$",
"description": "The user's type identifier (alphanumeric characters, underscores, and hyphens only)."
},
"phoneNumbers": {
"type": "array",
"description": "List of phone numbers associated with the user.",
"items": {
"$ref": "#/components/schemas/ScimMultiValueMobile"
}
},
"roles": {
"type": "array",
"maxItems": 1,
"description": "List of roles assigned to the user. At most one role may be specified.",
"items": {
"$ref": "#/components/schemas/ScimMultiValue"
}
},
"userName": {
"type": "string",
"format": "email",
"description": "The user's email address, used as the unique username."
},
"notify": {
"type": "boolean",
"default": false,
"description": "If true, sends a notification email to the user upon account creation."
},
"userMustChange": {
"type": "boolean",
"default": false,
"description": "If true, requires the user to change their password on first login."
}
},
"required": [
"schemas",
"userName"
]
},
"ScimMeta": {
"type": "object",
"properties": {
"resourceType": {
"type": "string",
"description": "SCIM resource type (e.g., User)."
},
"created": {
"type": "string",
"format": "date",
"description": "Date and time when the SCIM resource was created."
},
"lastModified": {
"type": "string",
"format": "date",
"description": "Date and time when the SCIM resource was last modified."
},
"location": {
"type": "string",
"description": "URI of the SCIM resource."
}
}
},
"ScimMultiValue1": {
"type": "object",
"properties": {
"value": {
"type": "string",
"description": "Value of the multi-value attribute (e.g., email address or phone number)."
},
"type": {
"type": "string",
"description": "Type label for the value (e.g., work, home)."
},
"primary": {
"type": "boolean",
"description": "Indicates whether this is the primary value for the attribute."
}
}
},
"ScimUser": {
"type": "object",
"properties": {
"schemas": {
"type": "array",
"description": "List of SCIM schema URIs applicable to this resource.",
"items": {
"type": "string"
}
},
"id": {
"type": "string",
"description": "Unique identifier of the SCIM user (maps to the user GUID)."
},
"meta": {
"description": "SCIM metadata for the user resource.",
"allOf": [
{
"$ref": "#/components/schemas/ScimMeta"
}
]
},
"userName": {
"type": "string",
"description": "Username of the SCIM user (maps to email address)."
},
"displayName": {
"type": "string",
"description": "Display name of the SCIM user."
},
"userType": {
"type": "string",
"description": "User type based on the assigned profile name."
},
"preferredLanguage": {
"type": "string",
"description": "Preferred language of the user."
},
"active": {
"type": "boolean",
"description": "Indicates whether the user account is active."
},
"emails": {
"description": "List of email addresses for the user.",
"type": "array",
"items": {
"$ref": "#/components/schemas/ScimMultiValue1"
}
},
"phoneNumbers": {
"description": "List of phone numbers for the user.",
"type": "array",
"items": {
"$ref": "#/components/schemas/ScimMultiValue1"
}
},
"photos": {
"description": "List of photo URLs for the user.",
"type": "array",
"items": {
"$ref": "#/components/schemas/ScimMultiValue1"
}
},
"roles": {
"description": "List of roles assigned to the user.",
"type": "array",
"items": {
"$ref": "#/components/schemas/ScimMultiValue1"
}
}
}
},
"ScimUsers": {
"type": "object",
"properties": {
"schemas": {
"type": "array",
"description": "List of SCIM schema URIs applicable to this response.",
"items": {
"type": "string"
}
},
"totalResults": {
"type": "integer",
"description": "Total number of matching SCIM users."
},
"itemsPerPage": {
"type": "integer",
"description": "Number of users returned per page."
},
"startIndex": {
"type": "integer",
"description": "1-based index of the first result in the current page."
},
"Resources": {
"description": "List of SCIM user resources.",
"type": "array",
"items": {
"$ref": "#/components/schemas/ScimUser"
}
}
}
},
"DataRetentionOption": {
"type": "object",
"properties": {
"remoteWipe": {
"type": "boolean",
"default": false,
"description": "If true, triggers a remote wipe of the user data from all registered devices."
},
"deleteUnsharedData": {
"type": "boolean",
"default": null,
"nullable": true,
"description": "If true, permanently deletes data that is not shared with other users."
},
"retainData": {
"type": "boolean",
"default": null,
"nullable": true,
"description": "If true, retains the user data after deletion."
},
"retainPermissionToSharedData": {
"type": "boolean",
"default": false,
"description": "If true, the specified `retainToUser` will retain access to shared data."
},
"retainToUser": {
"type": "string",
"default": false,
"description": "UUID of the user who will receive ownership of the deleted user data."
}
}
},
"ScimUsersPutRequest": {
"type": "object",
"properties": {
"schemas": {
"type": "array",
"minItems": 1,
"description": "List of SCIM schema URNs applicable to this resource. Must include `urn:ietf:params:scim:schemas:core:2.0:User`.",
"items": {
"type": "string"
}
},
"password": {
"type": "string",
"description": "The user's password."
},
"displayName": {
"type": "string",
"pattern": "^[^<>]+$",
"description": "The user's display name. Must not contain `<` or `>` characters."
},
"userType": {
"type": "string",
"pattern": "^[A-Za-z0-9_-]+$",
"description": "The user's type identifier (alphanumeric characters, underscores, and hyphens only)."
},
"phoneNumbers": {
"type": "array",
"description": "List of phone numbers associated with the user.",
"items": {
"$ref": "#/components/schemas/ScimMultiValueMobile"
}
},
"roles": {
"type": "array",
"maxItems": 1,
"description": "List of roles assigned to the user. At most one role may be specified.",
"items": {
"$ref": "#/components/schemas/ScimMultiValue"
}
},
"active": {
"type": "boolean",
"description": "If true, activates the user account; if false, deactivates it."
},
"userTypeDemotionOptions": {
"description": "Data retention options to apply when the user type is demoted.",
"allOf": [
{
"$ref": "#/components/schemas/DataRetentionOption"
}
]
}
},
"required": [
"schemas"
]
},
"LocationList": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Location"
}
},
"metadata": {
"$ref": "#/components/schemas/MetaData"
}
}
},
"NodeHealthStatusResponse": {
"type": "object",
"properties": {
"ok": {
"type": "integer",
"description": "Overall health status indicator. `1` means all components are healthy; `0` means one or more components are unhealthy."
}
}
},
"SubmissionRequest": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Name of the subfolder to create under the form owner's folder for this submission."
},
"submitter": {
"type": "string",
"format": "email",
"nullable": true,
"description": "Email address of the user submitting the form. Pass `null` to create an anonymous submission."
}
},
"required": [
"name",
"submitter"
]
},
"UploadLink": {
"type": "object",
"properties": {
"ref": {
"type": "string",
"format": "uuid",
"description": "Upload ref"
},
"created": {
"type": "string",
"format": "date",
"description": "Date and time when the upload link was created."
},
"parentId": {
"type": "integer",
"description": "Unique identifier of the parent folder where files will be uploaded."
},
"totalSize": {
"type": "integer",
"description": "Total size of the upload in bytes."
},
"uri": {
"type": "string",
"description": "Relative URI of the upload link."
},
"uploadUrl": {
"type": "string",
"description": "The complete URL for the upload link."
}
}
},
"EpgdbImportRequest": {
"type": "object",
"properties": {
"filename": {
"type": "string",
"description": "The filename of the EPGDB backup file being uploaded."
}
},
"required": [
"filename"
]
},
"EpgdbImportPost": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Upload session ID"
}
}
},
"SharedMailboxPostRequest": {
"type": "object",
"properties": {
"userId": {
"type": "string",
"description": "The UUID of the user to convert into a shared mailbox."
},
"memberIds": {
"type": "array",
"description": "List of member UUIDs to add to the shared mailbox. (Recommended request size <= 100)",
"items": {
"type": "string"
}
},
"remoteWipe": {
"type": "boolean",
"description": "If true, remotely wipes all devices associated with the user being converted."
},
"deleteUnsharedData": {
"type": "boolean",
"description": "If true, deletes any data that is not shared with other users after conversion."
},
"retainData": {
"type": "boolean",
"description": "If true, retains the user's data and transfers it to the specified `retainToUser`."
},
"retainToUser": {
"type": "string",
"description": "The UUID of the user who will receive the retained data."
},
"retainPermissionToSharedData": {
"type": "boolean",
"description": "If true, the `retainToUser` will also receive permissions to the shared data."
},
"retainToAdvancedFormUser": {
"type": "string",
"description": "The UUID of an alternate user for advanced data retention scenarios."
}
},
"required": [
"memberIds",
"userId"
]
},
"SharedMailboxPatchRequest": {
"type": "object",
"properties": {
"memberIds": {
"type": "array",
"description": "List of member ids (Recommended request size <= 100)",
"items": {
"type": "string"
}
}
},
"required": [
"memberIds"
]
},
"CardAction": {
"type": "object",
"properties": {
"type": {
"type": "string",
"description": "Type of card action."
},
"url": {
"type": "string",
"description": "URL the card action links to."
}
},
"required": [
"type"
]
},
"CardHost": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique identifier of the card host."
},
"name": {
"type": "string",
"description": "Display name of the card host."
}
},
"required": [
"id",
"name"
]
},
"Card": {
"type": "object",
"properties": {
"message": {
"type": "string",
"description": "Main message text of the card."
},
"description": {
"type": "string",
"description": "Descriptive text providing additional detail for the card."
},
"severity": {
"type": "string",
"description": "Severity level of the card."
},
"actions": {
"description": "List of actions available on the card.",
"type": "array",
"items": {
"$ref": "#/components/schemas/CardAction"
}
},
"type": {
"type": "string",
"description": "Type of the card."
},
"host": {
"description": "Host information associated with the card.",
"allOf": [
{
"$ref": "#/components/schemas/CardHost"
}
]
},
"data": {
"type": "object",
"description": "Additional structured data associated with the card."
}
},
"required": [
"description",
"message",
"severity",
"type"
]
},
"CardActionPostRequest": {
"type": "object",
"properties": {
"action": {
"type": "string",
"enum": [
"retry",
"delete"
],
"description": "The action to perform on the card.
`retry` \u2013 Retry the failed operation.
`delete` \u2013 Delete the card or related records."
},
"type": {
"type": "string",
"enum": [
"content_encryption",
"email_json_migration",
"system_security_scanning",
"events_table_monitor",
"appadmin_db",
"sysadmin_db",
"sysadmin_hosts",
"epg_warnings",
"safe_edit_server_health"
],
"description": "The type of card to perform the action on.
`content_encryption` \u2013 Content encryption card.
`email_json_migration` \u2013 Email JSON migration card.
`system_security_scanning` \u2013 System security scanning card.
`events_table_monitor` \u2013 Events table monitor card.
`appadmin_db` \u2013 Application admin database card.
`sysadmin_db` \u2013 System admin database card.
`sysadmin_hosts` \u2013 System admin hosts card.
`epg_warnings` \u2013 EPG warnings card.
`safe_edit_server_health` \u2013 Safe edit server health card."
},
"hostId": {
"type": "string",
"description": "The unique identifier of the host associated with the card."
},
"storageType": {
"type": "string",
"description": "The storage type for the files to process.
`user_files` \u2013 User file storage.
`replication_files` \u2013 Replication file storage."
},
"volume": {
"type": "string",
"description": "The storage volume containing the files to process."
},
"fileId": {
"type": "array",
"description": "List of file IDs to retry content encryption for.",
"items": {
"type": "integer"
}
},
"emailId": {
"type": "array",
"description": "List of email IDs to retry migrating to JSON format.",
"items": {
"type": "integer"
}
}
},
"required": [
"action",
"type"
]
},
"AdminFilePutRequest": {
"type": "object",
"properties": {
"ids": {
"type": "array",
"description": "List of file object IDs (UUID) to be updated.",
"items": {
"type": "string"
}
},
"expire": {
"type": "string",
"format": "date",
"description": "New expiration date for the selected files."
}
},
"required": [
"ids"
]
},
"Files": {
"type": "object",
"properties": {
"data": {
"description": "List of files.",
"type": "array",
"items": {
"$ref": "#/components/schemas/File"
}
}
}
},
"AdminFileRescan": {
"type": "object",
"properties": {
"msg": {
"type": "string",
"description": "The successful response message"
}
}
},
"AdminFolderPutRequest": {
"type": "object",
"properties": {
"ids": {
"type": "array",
"description": "List of folder object IDs to be updated.",
"items": {
"type": "string"
}
},
"expire": {
"type": "string",
"format": "date",
"description": "Expiration date for the folder."
},
"applyTo": {
"type": "string",
"enum": [
"folders_only",
"files_only",
"folders_and_files"
],
"description": "Defines the scope of the expiration update.
`folders` \u2013 Apply expiration to folders only.
`files` \u2013 Apply expiration to files only.
`folders_and_files` \u2013 Apply expiration to both folders and files."
},
"quota": {
"type": "integer",
"enum": [
1073741824,
2147483648,
5368709120,
10737418240,
53687091200,
-1
],
"description": "Storage quota for the folder in bytes. Must be one of the permitted sizes: 1 GB (1,073,741,824), 2 GB (2,147,483,648), 5 GB (5,368,709,120), 10 GB (10,737,418,240), 50 GB (53,687,091,200), or -1 for unlimited."
},
"applyToNestedFiles": {
"type": "boolean",
"description": "If set to `true`, expiration will also apply to files in child folders."
}
},
"required": [
"ids"
]
},
"KwDatabaseMetric": {
"type": "object",
"properties": {
"service_status": {
"type": "string",
"enum": [
"unknown",
"abnormal",
"warn",
"running",
"stopped"
],
"description": "The MariaDB service status.
`active` \u2013 Service is running.
`inactive` \u2013 Service is not running."
},
"active_connection_count": {
"type": "integer",
"description": "Real-time number of active database connections."
},
"wsrep_cluster_status": {
"type": "string",
"description": "Galera cluster status indicating whether this node is the primary component."
},
"wsrep_cluster_size": {
"type": "integer",
"description": "Number of healthy nodes in the Galera cluster."
},
"wsrep_local_state_comment": {
"type": "string",
"description": "Galera local state indicating readiness to accept read/write requests. `Synced` is the healthy value."
},
"memory_usage_mb": {
"type": "integer",
"description": "Real-time RSS memory usage of the MariaDB service in MB."
},
"cpu_usage_percentage": {
"type": "number",
"description": "Real-time CPU usage percentage by the MariaDB service."
},
"db_partition_free_mb": {
"type": "integer",
"description": "Free space available on the database partition in MB."
},
"db_partition_used_mb": {
"type": "integer",
"description": "Used space on the database partition in MB."
}
}
},
"WebRequestsMetric": {
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"unknown",
"abnormal",
"warn",
"running",
"stopped"
],
"description": "The Nginx service status.
`active` \u2013 Service is running.
`inactive` \u2013 Service is not running."
},
"active_connections": {
"type": "integer",
"description": "Real-time number of active connections to the local Nginx instance."
},
"reading": {
"type": "integer",
"description": "Real-time number of connections currently reading the request header."
},
"writing": {
"type": "integer",
"description": "Real-time number of connections currently writing a response."
},
"connection_efficiency": {
"type": "number",
"description": "Ratio of handled connections to accepted connections."
},
"avg_requests_per_connection": {
"type": "number",
"description": "Ratio of total requests to handled connections."
}
}
},
"JobQueuedMetric": {
"type": "object",
"properties": {
"service_status": {
"type": "string",
"enum": [
"unknown",
"abnormal",
"warn",
"running",
"stopped"
],
"description": "The job queue service status.
`active` \u2013 Service is running.
`inactive` \u2013 Service is not running."
},
"memory_usage_mb": {
"type": "integer",
"description": "RSS memory usage of the job queue service in MB."
},
"queue_jq_acfs_conv": {
"type": "integer",
"description": "Number of jobs in the file preview queue."
},
"queue_jq_scan": {
"type": "integer",
"description": "Number of jobs in the antivirus scan queue."
},
"queue_jq_acfs": {
"type": "integer",
"description": "Number of fingerprint jobs queued to be executed on the ACFS node."
},
"current_queued_job_count": {
"type": "integer",
"description": "Real-time number of jobs currently waiting in the queue."
},
"current_working_job_count": {
"type": "integer",
"description": "Real-time number of jobs currently being processed."
},
"current_failed_job_count": {
"type": "integer",
"description": "Real-time number of jobs that have failed."
}
}
},
"SftpMetric": {
"type": "object",
"properties": {
"active_connection_count": {
"type": "integer",
"description": "Number of active SFTP connections."
},
"memory_usage_mb": {
"type": "integer",
"description": "Total RSS memory usage by SFTP processes in MB."
}
}
},
"SystemResourcesMetric": {
"type": "object",
"properties": {
"total_memory_usage_mb": {
"type": "integer",
"description": "Total system RSS memory usage in MB."
},
"total_swap_usage_mb": {
"type": "integer",
"description": "Total system swap usage in MB."
},
"total_cpu_usage_percent": {
"type": "number",
"description": "Total system CPU usage as a percentage."
},
"system_load_average_1min": {
"type": "number",
"description": "System load average over the last 1 minute."
},
"system_load_average_5min": {
"type": "number",
"description": "System load average over the last 5 minutes."
},
"system_load_average_15min": {
"type": "number",
"description": "System load average over the last 15 minutes."
}
}
},
"NodeHealthMetricResponse": {
"type": "object",
"properties": {
"kw_database": {
"nullable": true,
"description": "Database health metrics. Present when `metric_name` is `kwDatabase` or `allMetrics`.",
"allOf": [
{
"$ref": "#/components/schemas/KwDatabaseMetric"
}
]
},
"web_requests": {
"nullable": true,
"description": "Web request health metrics. Present when `metric_name` is `webRequests` or `allMetrics`.",
"allOf": [
{
"$ref": "#/components/schemas/WebRequestsMetric"
}
]
},
"jobqueued": {
"nullable": true,
"description": "Job queue health metrics. Present when `metric_name` is `jobqueued` or `allMetrics`.",
"allOf": [
{
"$ref": "#/components/schemas/JobQueuedMetric"
}
]
},
"sftp": {
"nullable": true,
"description": "SFTP health metrics. Present when `metric_name` is `sftp` or `allMetrics`.",
"allOf": [
{
"$ref": "#/components/schemas/SftpMetric"
}
]
},
"system_resources": {
"nullable": true,
"description": "System resource metrics. Present when `metric_name` is `systemResources` or `allMetrics`.",
"allOf": [
{
"$ref": "#/components/schemas/SystemResourcesMetric"
}
]
}
}
},
"AdminUserImportError": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique identifier for the error."
},
"message": {
"type": "string",
"description": "Description of the error."
}
}
},
"AdminUserImport": {
"type": "object",
"properties": {
"added_users": {
"type": "integer",
"description": "Number of users successfully added."
},
"updated_users": {
"type": "integer",
"description": "Number of users successfully updated."
},
"failed_ids": {
"type": "array",
"description": "List of user emails that failed during import.",
"items": {
"type": "string"
}
},
"errors": {
"description": "List of error details encountered during import.",
"type": "array",
"items": {
"$ref": "#/components/schemas/AdminUserImportError"
}
}
}
},
"AdminDeleteTOTPSecretRequest": {
"type": "object",
"properties": {
"ids": {
"type": "array",
"minItems": 1,
"maxItems": 100,
"description": "List of user UUIDs whose TOTP secrets should be deleted. Must contain between 1 and 100 IDs.",
"items": {
"type": "string"
}
}
},
"required": [
"ids"
]
},
"UserSshPublicKey1": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "Unique identifier of the SSH public key."
},
"userId": {
"type": "string"
},
"publicKey": {
"type": "string",
"description": "SSH public key string."
},
"name": {
"type": "string",
"description": "Display name for the SSH public key."
},
"active": {
"type": "boolean",
"description": "Indicates whether the SSH public key is active and can be used for authentication."
},
"adminActive": {
"type": "boolean",
"description": "Indicates whether an administrator has enabled this SSH public key."
},
"deleted": {
"type": "boolean",
"description": "Indicates whether the SSH public key has been deleted."
}
}
},
"AdminUserSshPublicKeyList": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/UserSshPublicKey1"
}
}
}
},
"Error": {
"type": "object",
"properties": {
"code": {
"type": "string",
"description": "Error code"
},
"message": {
"type": "string",
"description": "Error message"
}
}
}
}
}
}