| Error | | type | "object" |
|---|
| properties | | errorCode | | type | "integer" |
|---|
| description | "Proprietary Cryptshare Server error code." |
|---|
| format | "int32" |
|---|
|
|---|
| errorMessage | | type | "string" |
|---|
| description | "Short description of the error code in English." |
|---|
|
|---|
|
|---|
|
|---|
| RequestVerificationBody | | type | "object" |
|---|
| properties | | verificationCode | | type | "string" |
|---|
| description | "Code that confirms this verification. Must be present unless requesting a verification using client-id." |
|---|
|
|---|
|
|---|
|
|---|
| ResponseVerificationToken | | type | "object" |
|---|
| properties | | data | | $ref | "#/components/schemas/VerificationToken" |
|---|
|
|---|
| meta | | type | "object" |
|---|
| additionalProperties | | type | "object" |
|---|
| description | "Additional response metadata." |
|---|
|
|---|
| description | "Additional response metadata." |
|---|
|
|---|
|
|---|
|
|---|
| VerificationToken | | type | "object" |
|---|
| properties | | token | | type | "string" |
|---|
| description | "The verification token" |
|---|
|
|---|
| validUntil | | type | "string" |
|---|
| description | "The valid to date of the token. ISO 8601 with 'T' separator and numeric timezone." |
|---|
| example | "2020-10-09T11:51:46+02:00" |
|---|
|
|---|
|
|---|
| description | "Main data of the response." |
|---|
|
|---|
| Recipient | | required | |
|---|
| type | "object" |
|---|
| properties | | mail | | maxLength | 200 |
|---|
| minLength | 0 |
|---|
| type | "string" |
|---|
| description | "The recipient email address." |
|---|
|
|---|
|
|---|
| description | "The 'BCC' recipients." |
|---|
|
|---|
| Recipients | | required | |
|---|
| type | "object" |
|---|
| properties | | to | | uniqueItems | true |
|---|
| type | "array" |
|---|
| description | "The 'To' recipients." |
|---|
| items | | $ref | "#/components/schemas/Recipient" |
|---|
|
|---|
|
|---|
| cc | | uniqueItems | true |
|---|
| type | "array" |
|---|
| description | "The 'CC' recipients." |
|---|
| items | | $ref | "#/components/schemas/Recipient" |
|---|
|
|---|
|
|---|
| bcc | | uniqueItems | true |
|---|
| type | "array" |
|---|
| description | "The 'BCC' recipients." |
|---|
| items | | $ref | "#/components/schemas/Recipient" |
|---|
|
|---|
|
|---|
|
|---|
| description | "The recipients of the transfer grouped by to, cc and bcc." |
|---|
|
|---|
| Sender | | required | |
|---|
| type | "object" |
|---|
| properties | | name | | maxLength | 200 |
|---|
| minLength | 0 |
|---|
| type | "string" |
|---|
| description | "The sender name." |
|---|
|
|---|
| phone | | maxLength | 200 |
|---|
| minLength | 0 |
|---|
| type | "string" |
|---|
| description | "The sender phone." |
|---|
|
|---|
|
|---|
| description | "The sender of the transfer (without email)." |
|---|
|
|---|
| TransferSessionCreationOptions | | required | |
|---|
| type | "object" |
|---|
| properties | | sender | | $ref | "#/components/schemas/Sender" |
|---|
|
|---|
| recipients | | $ref | "#/components/schemas/Recipients" |
|---|
|
|---|
|
|---|
| description | "The options to use for the creation of the transfer." |
|---|
|
|---|
| TransferFileCreationOptions | | required | |
|---|
| type | "object" |
|---|
| properties | | fileName | | maxLength | 4000 |
|---|
| minLength | 0 |
|---|
| type | "string" |
|---|
| description | "The name of the file." |
|---|
|
|---|
| size | | minimum | 0 |
|---|
| type | "integer" |
|---|
| description | "The file size in bytes. This may be provided to allow the server to give early feedback regarding exceeded size limits." |
|---|
| format | "int64" |
|---|
|
|---|
| checksum | | maxLength | 1024 |
|---|
| minLength | 0 |
|---|
| type | "string" |
|---|
| description | "The checksum of the file. This may be provided to check the file integrity during processing. For the used algorithm, see the corresponding transfer session." |
|---|
| example | "737b6a930368b34c9ef9022ab088ac9b0b7abf8ef9046929c5d2fea3f87e7d15" |
|---|
|
|---|
|
|---|
| description | "The options to use for the creation of the file." |
|---|
|
|---|
| ResponseTransferFileCreationOptions | | type | "object" |
|---|
| properties | | data | | $ref | "#/components/schemas/TransferFileCreationOptions" |
|---|
|
|---|
| meta | | type | "object" |
|---|
| additionalProperties | | type | "object" |
|---|
| description | "Additional response metadata." |
|---|
|
|---|
| description | "Additional response metadata." |
|---|
|
|---|
|
|---|
|
|---|
| TransferPolicyRequest | | type | "object" |
|---|
| properties | | recipients | | type | "array" |
|---|
| writeOnly | true |
|---|
| items | |
|---|
|
|---|
|
|---|
| description | "The parameters to perform the policy request with." |
|---|
|
|---|
| FailedRecipient | | type | "object" |
|---|
| properties | | emailAddress | | type | "string" |
|---|
| description | "The email address of the failed recipient." |
|---|
| example | "abc.def@example.com" |
|---|
|
|---|
| reason | | type | "string" |
|---|
| description | "The reason of the denial of the recipient. Currently, only 'ADMINISTRATIVE_REASONS' is supported." |
|---|
| enum | |
|---|
|
|---|
|
|---|
| description | "List of all recipients to which the given sender is not allowed to perform a transfer. This is only set if the transfer would not be allowed." |
|---|
|
|---|
| ResponseTransferPolicyResult | | type | "object" |
|---|
| properties | | data | | $ref | "#/components/schemas/TransferPolicyResult" |
|---|
|
|---|
| meta | | type | "object" |
|---|
| additionalProperties | | type | "object" |
|---|
| description | "Additional response metadata." |
|---|
|
|---|
| description | "Additional response metadata." |
|---|
|
|---|
|
|---|
|
|---|
| SecurityModeConfigDto | | type | "object" |
|---|
| description | "Configuration of the security mode. Depending on the type (see 'name' property) this is one of OneTimePasswordSecurityModeConfig (for 'ONE_TIME_PASSWORD'), QuickSecurityModeConfig (for 'QUICK'), or EidSecurityModeConfig (for 'EID')." |
|---|
|
|---|
| SecurityModeDtoSecurityModeConfigDto | | type | "object" |
|---|
| properties | | name | | type | "string" |
|---|
| description | "Name of the security mode." |
|---|
| enum | | "ONE_TIME_PASSWORD" |
| "QUICK" |
| "EID" |
|
|---|
|
|---|
| config | | $ref | "#/components/schemas/SecurityModeConfigDto" |
|---|
|
|---|
|
|---|
| description | "List of available security modes (OneTimePasswordSecurityMode, QuickSecurityMode, EidSecurityMode), ordered by priority. The first element is meant to be set as default by the client." |
|---|
|
|---|
| TransferPolicyResult | | type | "object" |
|---|
| properties | | allowed | | type | "boolean" |
|---|
| description | "Whether a transfer with the requested sender-recipient combination would be allowed or not. Please note that if the user isn't allowed as sender at all, the request would result in a error response instead." |
|---|
| example | true |
|---|
|
|---|
| settings | | $ref | "#/components/schemas/TransferPolicySettings" |
|---|
|
|---|
| failedRecipients | | uniqueItems | true |
|---|
| type | "array" |
|---|
| description | "List of all recipients to which the given sender is not allowed to perform a transfer. This is only set if the transfer would not be allowed." |
|---|
| items | | $ref | "#/components/schemas/FailedRecipient" |
|---|
|
|---|
|
|---|
|
|---|
| description | "Main data of the response." |
|---|
|
|---|
| TransferPolicySettings | | type | "object" |
|---|
| properties | | maxRetentionPeriod | | type | "integer" |
|---|
| description | "Max. number of days the transfer is retrievable, starting at the transfer's provision time." |
|---|
| format | "int64" |
|---|
| example | 30 |
|---|
|
|---|
| maxTotalSize | | type | "integer" |
|---|
| description | "Max. total size of all files in bytes." |
|---|
| format | "int64" |
|---|
| example | 2147483648 |
|---|
|
|---|
| showFileNamesDefault | | type | "boolean" |
|---|
| description | "Default setting for showing file names in notifications and logs." |
|---|
|
|---|
| showFileNamesChangeable | | type | "boolean" |
|---|
| description | "Specifies whether the showFileNamesDefault setting is changeable or not." |
|---|
|
|---|
| showZipFileContentDefault | | type | "boolean" |
|---|
| description | "Default setting for showing file names within ZIP files in notifications and logs. This only has an effect if file names are shown in general." |
|---|
|
|---|
| sendDownloadNotificationsDefault | | type | "boolean" |
|---|
| description | "Default setting for sending download notifications on file retrieval." |
|---|
|
|---|
| sendDownloadNotificationsChangeable | | type | "boolean" |
|---|
| description | "Specifies whether the sendDownloadNotificationsDefault setting is changeable or not." |
|---|
|
|---|
| confidentialMessageAllowed | | type | "boolean" |
|---|
| description | "Specifies whether a confidential message can be part of the transfer or not." |
|---|
|
|---|
| confidentialMessageRequired | | type | "boolean" |
|---|
| description | "Specifies whether a confidential message has to be part of the transfer or not." |
|---|
|
|---|
| recipientNotificationEditable | | type | "boolean" |
|---|
| description | "Specifies whether the recipient notification can be edited or not." |
|---|
|
|---|
| securityModes | | type | "array" |
|---|
| description | "List of available security modes (OneTimePasswordSecurityMode, QuickSecurityMode, EidSecurityMode), ordered by priority. The first element is meant to be set as default by the client." |
|---|
| items | | $ref | "#/components/schemas/SecurityModeDtoSecurityModeConfigDto" |
|---|
|
|---|
|
|---|
|
|---|
| description | "The evaluated policy settings of the matching policy rules. This is only set the transfer would be allowed at all." |
|---|
|
|---|
| Password-Wrapper | | required | |
|---|
| type | "object" |
|---|
| properties | |
|---|
|
|---|
| Details | | type | "object" |
|---|
| description | "Details of the rule." |
|---|
|
|---|
| PasswordValidationResult | | type | "object" |
|---|
| properties | | valid | | type | "boolean" |
|---|
| description | "Whether the given password is valid." |
|---|
|
|---|
| rulesNotFulfilled | | type | "array" |
|---|
| description | "List of rules that are not fulfilled by the given password" |
|---|
| items | | $ref | "#/components/schemas/PasswordValidationRule" |
|---|
|
|---|
|
|---|
|
|---|
| description | "Results of the validation of a given password" |
|---|
|
|---|
| PasswordValidationRule | | type | "object" |
|---|
| properties | | name | | type | "string" |
|---|
| description | "Name of the rule." |
|---|
|
|---|
| details | | $ref | "#/components/schemas/Details" |
|---|
|
|---|
|
|---|
| description | "Represents a rule a password has to fulfill to be valid" |
|---|
|
|---|
| ResponsePasswordValidationResult | | type | "object" |
|---|
| properties | | data | | $ref | "#/components/schemas/PasswordValidationResult" |
|---|
|
|---|
| meta | | type | "object" |
|---|
| additionalProperties | | type | "object" |
|---|
| description | "Additional response metadata." |
|---|
|
|---|
| description | "Additional response metadata." |
|---|
|
|---|
|
|---|
|
|---|
| LogEntry | | type | "object" |
|---|
| properties | | timestamp | | type | "string" |
|---|
| description | "ISO 8601 with 'T' separator and numeric timezone." |
|---|
| example | "2020-10-09T11:51:46+02:00" |
|---|
|
|---|
| level | | type | "string" |
|---|
| description | "Assumes a severity ordering as specified by RFC 5424." |
|---|
| enum | | "trace" |
| "debug" |
| "info" |
| "warn" |
| "error" |
|
|---|
|
|---|
| message | | type | "string" |
|---|
| description | "The log message." |
|---|
|
|---|
|
|---|
|
|---|
| TransferNotificationMessage | | type | "object" |
|---|
| properties | | subject | | maxLength | 255 |
|---|
| minLength | 0 |
|---|
| pattern | "^[^<>\\/#,\]\[\}\{%\$~]*$" |
|---|
| type | "string" |
|---|
| description | "The subject of the transfer notification." |
|---|
|
|---|
| body | | type | "string" |
|---|
| description | "The body of the transfer notification. May contain HTML." |
|---|
|
|---|
|
|---|
| description | "The notification mail that will be sent to the recipients." |
|---|
|
|---|
| TransferOneTimePasswordSecurityMode | | type | "object" |
|---|
| allOf | | $ref | "#/components/schemas/TransferSecurityModeObject" |
|---|
|
| type | "object" |
|---|
| properties | | config | | $ref | "#/components/schemas/TransferOneTimePasswordSecurityModeConfig" |
|---|
|
|---|
|
|---|
|
|
|---|
|
|---|
| TransferOneTimePasswordSecurityModeConfig | | type | "object" |
|---|
| properties | | passwordMode | | type | "string" |
|---|
| description | "The password mode to use. Note that if 'GENERATED' is used, the password is calculated by the server." |
|---|
| enum | | "MANUAL" |
| "GENERATED" |
| "NONE" |
|
|---|
|
|---|
| password | | type | "string" |
|---|
| description | "The password for the transfer." |
|---|
|
|---|
|
|---|
| description | "The configuration of the security mode." |
|---|
|
|---|
| TransferSecurityModeObject | | type | "object" |
|---|
| properties | | name | | type | "string" |
|---|
| description | "The identifier for this security mode." |
|---|
| enum | |
|---|
|
|---|
| config | | type | "object" |
|---|
| description | "The configuration of the security mode." |
|---|
|
|---|
|
|---|
| description | "Security mode. Possible implementations are: 'TransferOneTimePasswordSecurityMode'" |
|---|
| discriminator | |
|---|
|
|---|
| TransferSessionPatchable | | type | "object" |
|---|
| properties | | sender | | $ref | "#/components/schemas/Sender" |
|---|
|
|---|
| expirationDate | | type | "string" |
|---|
| description | "The expiration date of the transfer. ISO 8601 with 'T' separator and numeric timezone." |
|---|
| example | "2020-10-09T11:51:46+02:00" |
|---|
|
|---|
| securityMode | | oneOf | | $ref | "#/components/schemas/TransferOneTimePasswordSecurityMode" |
|---|
|
|
|---|
|
|---|
| notificationMessage | | $ref | "#/components/schemas/TransferNotificationMessage" |
|---|
|
|---|
| fileChecksumAlgorithm | | maxLength | 50 |
|---|
| minLength | 0 |
|---|
| type | "string" |
|---|
| description | "The name of the hashing algorithm that will be used for files in this transfer." |
|---|
| example | "SHA-256" |
|---|
|
|---|
| senderLanguage | | type | "string" |
|---|
| description | "The sender language. Initially, this is set to the value of the 'Accept-Language' header. IETF BCP 47 language tag, RFC 5646. Format: <language>[-<region>]. Case insensitive." |
|---|
| example | "en" |
|---|
|
|---|
| recipientLanguage | | type | "string" |
|---|
| description | "The recipient language. IETF BCP 47 language tag, RFC 5646. Format: <language>[-<region>]. Case insensitive." |
|---|
| example | "en" |
|---|
|
|---|
| showFileNames | | type | "boolean" |
|---|
| description | "If file names should be shown in notification mails." |
|---|
|
|---|
| showZipFileContent | | type | "boolean" |
|---|
| description | "If the contents of ZIP files should be shown in notification mails. Has no effect if `showFileNames` is false." |
|---|
|
|---|
| sendDownloadNotifications | | type | "boolean" |
|---|
| description | "If notification mails should be sent to the sender when a file is downloaded." |
|---|
|
|---|
| sendDownloadSummary | | type | "boolean" |
|---|
| description | "If a summary notification mail should be sent to the sender the transfer expires." |
|---|
|
|---|
| sendUploadSummary | | type | "boolean" |
|---|
| description | "If a confirmation notification mail should be sent to the sender after the transfer is provided." |
|---|
|
|---|
| sendRecipientNotification | | type | "boolean" |
|---|
| description | "If notification mails should be sent to the recipients after the transfer is provided." |
|---|
|
|---|
| classificationId | | maxLength | 4000 |
|---|
| minLength | 0 |
|---|
| type | "string" |
|---|
| description | "An optional ID for the type of classification used for this transfer." |
|---|
|
|---|
| confidentialMessageFileId | | type | "string" |
|---|
| description | "The file ID of the confidential message. May be null." |
|---|
|
|---|
|
|---|
|
|---|
| ResponseTransferSessionTransferSecurityModeObject | | type | "object" |
|---|
| properties | | data | | $ref | "#/components/schemas/TransferSessionTransferSecurityModeObject" |
|---|
|
|---|
| meta | | type | "object" |
|---|
| additionalProperties | | type | "object" |
|---|
| description | "Additional response metadata." |
|---|
|
|---|
| description | "Additional response metadata." |
|---|
|
|---|
|
|---|
|
|---|
| TransferSessionFile | | type | "object" |
|---|
| properties | | id | | type | "string" |
|---|
| description | "The ID of this file." |
|---|
| example | "a58dFp1Tr7" |
|---|
|
|---|
| fileName | | type | "string" |
|---|
| description | "The name of the file." |
|---|
| example | "Invoice.pdf" |
|---|
|
|---|
| size | | type | "integer" |
|---|
| description | "The file size in bytes." |
|---|
| format | "int64" |
|---|
| example | 13987 |
|---|
|
|---|
| checksum | | type | "string" |
|---|
| description | "The checksum of the file." |
|---|
| example | "737b6a930368b34c9ef9022ab088ac9b0b7abf8ef9046929c5d2fea3f87e7d15" |
|---|
|
|---|
| href | | type | "string" |
|---|
| description | "The absolute path to the transfer file." |
|---|
|
|---|
| state | | type | "string" |
|---|
| description | "The state of this file." |
|---|
| enum | | "ACTIVE" |
| "INITIALIZED" |
| "UPLOADED" |
| "REMOVED" |
|
|---|
|
|---|
|
|---|
| description | "The files of this transfer." |
|---|
|
|---|
| TransferSessionTransferSecurityModeObject | | type | "object" |
|---|
| properties | | sender | | $ref | "#/components/schemas/Sender" |
|---|
|
|---|
| recipients | | $ref | "#/components/schemas/Recipients" |
|---|
|
|---|
| expirationDate | | type | "string" |
|---|
| description | "The expiration date of the transfer. ISO 8601 with 'T' separator and numeric timezone." |
|---|
| example | "2020-10-09T11:51:46+02:00" |
|---|
|
|---|
| securityMode | | oneOf | | $ref | "#/components/schemas/TransferOneTimePasswordSecurityMode" |
|---|
|
|
|---|
|
|---|
| notificationMessage | | $ref | "#/components/schemas/TransferNotificationMessage" |
|---|
|
|---|
| senderLanguage | | type | "string" |
|---|
| description | "The sender language. Initially, this is set to the value of the 'Accept-Language' header. IETF BCP 47 language tag, RFC 5646. Format: <language>[-<region>]. Case insensitive." |
|---|
| example | "en" |
|---|
|
|---|
| recipientLanguage | | type | "string" |
|---|
| description | "The recipient language. IETF BCP 47 language tag, RFC 5646. Format: <language>[-<region>]. Case insensitive." |
|---|
| example | "en" |
|---|
|
|---|
| showFileNames | | type | "boolean" |
|---|
| description | "If file names should be shown in notification mails." |
|---|
|
|---|
| showZipFileContent | | type | "boolean" |
|---|
| description | "If the contents of ZIP files should be shown in notification mails. Has no effect if `showFileNames` is false." |
|---|
|
|---|
| sendDownloadNotifications | | type | "boolean" |
|---|
| description | "If notification mails should be sent to the sender when a file is downloaded." |
|---|
|
|---|
| sendDownloadSummary | | type | "boolean" |
|---|
| description | "If a summary notification mail should be sent to the sender the transfer expires." |
|---|
|
|---|
| sendUploadSummary | | type | "boolean" |
|---|
| description | "If a confirmation notification mail should be sent to the sender after the transfer is provided." |
|---|
|
|---|
| sendRecipientNotification | | type | "boolean" |
|---|
| description | "If notification mails should be sent to the recipients after the transfer is provided." |
|---|
|
|---|
| classificationId | | maxLength | 4000 |
|---|
| minLength | 0 |
|---|
| type | "string" |
|---|
| description | "An optional ID for the type of classification used for this transfer." |
|---|
|
|---|
| fileChecksumAlgorithm | | maxLength | 50 |
|---|
| minLength | 0 |
|---|
| type | "string" |
|---|
| description | "The name of the hashing algorithm that will be used for files in this transfer." |
|---|
| example | "SHA-256" |
|---|
|
|---|
| confidentialMessageFileId | | type | "string" |
|---|
| description | "The file ID of the confidential message. May be null." |
|---|
|
|---|
| files | | uniqueItems | true |
|---|
| type | "array" |
|---|
| description | "The files of this transfer." |
|---|
| items | | $ref | "#/components/schemas/TransferSessionFile" |
|---|
|
|---|
|
|---|
|
|---|
| description | "Main data of the response." |
|---|
|
|---|
| ResponseVerificationStatus | | type | "object" |
|---|
| properties | | data | | $ref | "#/components/schemas/VerificationStatus" |
|---|
|
|---|
| meta | | type | "object" |
|---|
| additionalProperties | | type | "object" |
|---|
| description | "Additional response metadata." |
|---|
|
|---|
| description | "Additional response metadata." |
|---|
|
|---|
|
|---|
|
|---|
| VerificationStatus | | type | "object" |
|---|
| properties | | validUntil | | type | "string" |
|---|
| description | "The valid to date of the token. ISO 8601 with 'T' separator and numeric timezone." |
|---|
| example | "2020-10-09T11:51:46+02:00" |
|---|
|
|---|
| verified | | type | "boolean" |
|---|
| description | "The state if the client is verified for the specified email address." |
|---|
| example | true |
|---|
|
|---|
| verificationMethods | | uniqueItems | true |
|---|
| type | "array" |
|---|
| description | "A list of available verification methods." |
|---|
| items | | type | "string" |
|---|
| description | "A list of available verification methods." |
|---|
| enum | | "clientId" |
| "email" |
| "clientId" |
| "email" |
|
|---|
|
|---|
| enum | |
|---|
|
|---|
|
|---|
| description | "Main data of the response." |
|---|
|
|---|
| DownloadDto | | type | "object" |
|---|
| properties | | downloadDate | | type | "string" |
|---|
| description | "The date of the download. ISO 8601 with 'T' separator and numeric timezone." |
|---|
| example | "2020-10-09T11:51:46+02:00" |
|---|
|
|---|
| retrievalMethod | | type | "string" |
|---|
| description | "The method how the file was retrieved: Downloaded or viewed in Content Viewer." |
|---|
| enum | |
|---|
|
|---|
|
|---|
| description | "The list of downloads of this file." |
|---|
|
|---|
| FileDownloadDto | | type | "object" |
|---|
| properties | | id | | type | "string" |
|---|
| description | "The file ID." |
|---|
|
|---|
| downloads | | type | "array" |
|---|
| description | "The list of downloads of this file." |
|---|
| items | | $ref | "#/components/schemas/DownloadDto" |
|---|
|
|---|
|
|---|
|
|---|
|
|---|
| RecipientStatusDto | | type | "object" |
|---|
| properties | | mail | | type | "string" |
|---|
| description | "The recipient email address." |
|---|
|
|---|
| downloadUrl | | type | "string" |
|---|
| description | "The URL this recipient can use to access this transfer. This URL is meant to be used by a real user, not an API. This field is set to null only if the password mode is none and a different verification token is used than the one when this transfer was created with." |
|---|
|
|---|
| id | | type | "string" |
|---|
| description | "The recipient transfer ID." |
|---|
|
|---|
| notificationFailed | | type | "boolean" |
|---|
| description | "If notification of this recipient failed." |
|---|
|
|---|
| fileDownloads | | uniqueItems | true |
|---|
| type | "array" |
|---|
| items | | $ref | "#/components/schemas/FileDownloadDto" |
|---|
|
|---|
|
|---|
|
|---|
|
|---|
| ResponseListTransferBasicInfoDto | | type | "object" |
|---|
| properties | | data | | type | "array" |
|---|
| description | "Main data of the response." |
|---|
| items | | $ref | "#/components/schemas/TransferBasicInfoDto" |
|---|
|
|---|
|
|---|
| meta | | type | "object" |
|---|
| additionalProperties | | type | "object" |
|---|
| description | "Additional response metadata." |
|---|
|
|---|
| description | "Additional response metadata." |
|---|
|
|---|
|
|---|
|
|---|
| TransferBasicInfoDto | | type | "object" |
|---|
| properties | | trackingId | | type | "string" |
|---|
| description | "The tracking ID." |
|---|
|
|---|
| state | | type | "string" |
|---|
| description | "The state of the transfer." |
|---|
| enum | | "UNKNOWN" |
| "PENDING" |
| "ACTIVE" |
| "DELETED_BY_EXPIRATION" |
| "DELETED_BY_REVOCATION" |
| "DELETED_BY_ADMIN" |
| "DELETED_BY_SECURITY" |
| "PROCESSING" |
| "FAILED" |
|
|---|
|
|---|
| recipients | | uniqueItems | true |
|---|
| type | "array" |
|---|
| items | | $ref | "#/components/schemas/RecipientStatusDto" |
|---|
|
|---|
|
|---|
| href | | type | "string" |
|---|
| description | "The absolute path to the transfer." |
|---|
|
|---|
|
|---|
| description | "Main data of the response." |
|---|
|
|---|
| FileStatusDto | | type | "object" |
|---|
| properties | | id | | type | "string" |
|---|
| description | "The file ID." |
|---|
|
|---|
| removed | | type | "boolean" |
|---|
| description | "If this file was removed." |
|---|
|
|---|
| removalCause | | type | "string" |
|---|
| description | "A formatted text with details why this file was removed. May be null." |
|---|
|
|---|
|
|---|
|
|---|
| ResponseTransferStatus | | type | "object" |
|---|
| properties | | data | | $ref | "#/components/schemas/TransferStatus" |
|---|
|
|---|
| meta | | type | "object" |
|---|
| additionalProperties | | type | "object" |
|---|
| description | "Additional response metadata." |
|---|
|
|---|
| description | "Additional response metadata." |
|---|
|
|---|
|
|---|
|
|---|
| SenderStatusDto | | type | "object" |
|---|
| properties | | email | | type | "string" |
|---|
| description | "The sender email address." |
|---|
|
|---|
| notificationFailed | | type | "boolean" |
|---|
| description | "If notification of the sender failed." |
|---|
|
|---|
|
|---|
|
|---|
| StatusDto | | type | "object" |
|---|
| properties | | state | | type | "string" |
|---|
| description | "The state of the transfer." |
|---|
| enum | | "ACTIVE" |
| "DELETED_BY_EXPIRATION" |
| "DELETED_BY_REVOCATION" |
| "DELETED_BY_ADMIN" |
| "DELETED_BY_SECURITY" |
| "PROCESSING" |
| "FAILED" |
|
|---|
|
|---|
| warnings | | type | "boolean" |
|---|
| description | "If any warnings were encountered. This could be for example files that were removed." |
|---|
|
|---|
| emlCreationFailed | | type | "boolean" |
|---|
| description | "If the creation of the EML file failed." |
|---|
|
|---|
| sender | | $ref | "#/components/schemas/SenderStatusDto" |
|---|
|
|---|
| recipients | | uniqueItems | true |
|---|
| type | "array" |
|---|
| items | | $ref | "#/components/schemas/RecipientStatusDto" |
|---|
|
|---|
|
|---|
| files | | uniqueItems | true |
|---|
| type | "array" |
|---|
| items | | $ref | "#/components/schemas/FileStatusDto" |
|---|
|
|---|
|
|---|
|
|---|
|
|---|
| TransferSessionObject | | type | "object" |
|---|
| properties | | sender | | $ref | "#/components/schemas/Sender" |
|---|
|
|---|
| recipients | | $ref | "#/components/schemas/Recipients" |
|---|
|
|---|
| expirationDate | | type | "string" |
|---|
| description | "The expiration date of the transfer. ISO 8601 with 'T' separator and numeric timezone." |
|---|
| example | "2020-10-09T11:51:46+02:00" |
|---|
|
|---|
| securityMode | | type | "object" |
|---|
| description | "The security mode for this transfer." |
|---|
|
|---|
| notificationMessage | | $ref | "#/components/schemas/TransferNotificationMessage" |
|---|
|
|---|
| senderLanguage | | type | "string" |
|---|
| description | "The sender language. Initially, this is set to the value of the 'Accept-Language' header. IETF BCP 47 language tag, RFC 5646. Format: <language>[-<region>]. Case insensitive." |
|---|
| example | "en" |
|---|
|
|---|
| recipientLanguage | | type | "string" |
|---|
| description | "The recipient language. IETF BCP 47 language tag, RFC 5646. Format: <language>[-<region>]. Case insensitive." |
|---|
| example | "en" |
|---|
|
|---|
| showFileNames | | type | "boolean" |
|---|
| description | "If file names should be shown in notification mails." |
|---|
|
|---|
| showZipFileContent | | type | "boolean" |
|---|
| description | "If the contents of ZIP files should be shown in notification mails. Has no effect if `showFileNames` is false." |
|---|
|
|---|
| sendDownloadNotifications | | type | "boolean" |
|---|
| description | "If notification mails should be sent to the sender when a file is downloaded." |
|---|
|
|---|
| sendDownloadSummary | | type | "boolean" |
|---|
| description | "If a summary notification mail should be sent to the sender the transfer expires." |
|---|
|
|---|
| sendUploadSummary | | type | "boolean" |
|---|
| description | "If a confirmation notification mail should be sent to the sender after the transfer is provided." |
|---|
|
|---|
| sendRecipientNotification | | type | "boolean" |
|---|
| description | "If notification mails should be sent to the recipients after the transfer is provided." |
|---|
|
|---|
| classificationId | | maxLength | 4000 |
|---|
| minLength | 0 |
|---|
| type | "string" |
|---|
| description | "An optional ID for the type of classification used for this transfer." |
|---|
|
|---|
| fileChecksumAlgorithm | | maxLength | 50 |
|---|
| minLength | 0 |
|---|
| type | "string" |
|---|
| description | "The name of the hashing algorithm that will be used for files in this transfer." |
|---|
| example | "SHA-256" |
|---|
|
|---|
| confidentialMessageFileId | | type | "string" |
|---|
| description | "The file ID of the confidential message. May be null." |
|---|
|
|---|
| files | | uniqueItems | true |
|---|
| type | "array" |
|---|
| description | "The files of this transfer." |
|---|
| items | | $ref | "#/components/schemas/TransferSessionFile" |
|---|
|
|---|
|
|---|
|
|---|
|
|---|
| TransferStatus | | type | "object" |
|---|
| properties | | transfer | | $ref | "#/components/schemas/TransferSessionObject" |
|---|
|
|---|
| status | | $ref | "#/components/schemas/StatusDto" |
|---|
|
|---|
|
|---|
| description | "Main data of the response." |
|---|
|
|---|
| ResponseTransferInfo | | type | "object" |
|---|
| properties | | data | | $ref | "#/components/schemas/TransferInfo" |
|---|
|
|---|
| meta | | type | "object" |
|---|
| additionalProperties | | type | "object" |
|---|
| description | "Additional response metadata." |
|---|
|
|---|
| description | "Additional response metadata." |
|---|
|
|---|
|
|---|
|
|---|
| TransferInfo | | type | "object" |
|---|
| properties | | totalSize | | type | "integer" |
|---|
| description | "The total file size in bytes." |
|---|
| format | "int64" |
|---|
| example | 13987 |
|---|
|
|---|
| checksumAlgorithm | | type | "string" |
|---|
| description | "The checksum algorithm used for checksum generation." |
|---|
| example | "SHA-256" |
|---|
|
|---|
|
|---|
| description | "Main data of the response." |
|---|
|
|---|
| ResponseListTransferFile | | type | "object" |
|---|
| properties | | data | | type | "array" |
|---|
| description | "Main data of the response." |
|---|
| items | | $ref | "#/components/schemas/TransferFile" |
|---|
|
|---|
|
|---|
| meta | | type | "object" |
|---|
| additionalProperties | | type | "object" |
|---|
| description | "Additional response metadata." |
|---|
|
|---|
| description | "Additional response metadata." |
|---|
|
|---|
|
|---|
|
|---|
| TransferFile | | type | "object" |
|---|
| properties | | id | | type | "string" |
|---|
| description | "The ID of this file." |
|---|
| example | "a58dFp1Tr7" |
|---|
|
|---|
| fileName | | type | "string" |
|---|
| description | "The name of the file." |
|---|
| example | "Invoice.pdf" |
|---|
|
|---|
| size | | type | "integer" |
|---|
| description | "The file size in bytes." |
|---|
| format | "int64" |
|---|
| example | 13987 |
|---|
|
|---|
| checksum | | type | "string" |
|---|
| description | "The checksum of the file." |
|---|
| example | "737b6a930368b34c9ef9022ab088ac9b0b7abf8ef9046929c5d2fea3f87e7d15" |
|---|
|
|---|
| href | | type | "string" |
|---|
| description | "The absolute path to the transfer file." |
|---|
|
|---|
|
|---|
| description | "Main data of the response." |
|---|
|
|---|
| LoggingSettings | | type | "object" |
|---|
| properties | | level | | type | "string" |
|---|
| description | "Assumes a severity ordering as specified by RFC 5424." |
|---|
| enum | | "trace" |
| "debug" |
| "info" |
| "warn" |
| "error" |
|
|---|
|
|---|
| remoteLoggingEnabled | | type | "boolean" |
|---|
| description | "Specifies whether the requesting client should send its log entries to the Cryptshare Server." |
|---|
| example | true |
|---|
|
|---|
|
|---|
| description | "Main data of the response." |
|---|
|
|---|
| ResponseLoggingSettings | | type | "object" |
|---|
| properties | | data | | $ref | "#/components/schemas/LoggingSettings" |
|---|
|
|---|
| meta | | type | "object" |
|---|
| additionalProperties | | type | "object" |
|---|
| description | "Additional response metadata." |
|---|
|
|---|
| description | "Additional response metadata." |
|---|
|
|---|
|
|---|
|
|---|
| ResponseTermsOfUseInfo | | type | "object" |
|---|
| properties | | data | | $ref | "#/components/schemas/TermsOfUseInfo" |
|---|
|
|---|
| meta | | type | "object" |
|---|
| additionalProperties | | type | "object" |
|---|
| description | "Additional response metadata." |
|---|
|
|---|
| description | "Additional response metadata." |
|---|
|
|---|
|
|---|
|
|---|
| TermsOfUse | | type | "object" |
|---|
| properties | | locale | | type | "string" |
|---|
| description | "IETF BCP 47 language tag, RFC 5646. Format: <language>[-<region>]. Case insensitive." |
|---|
| example | "en-US" |
|---|
|
|---|
| title | | type | "string" |
|---|
| description | "Title of the terms of use, in the respective language." |
|---|
| example | "Cryptshare at ACME Inc., Terms of Use" |
|---|
|
|---|
| content | | type | "string" |
|---|
| description | "Either an URL pointing to the terms of use (type 'link') or the content of the terms of use itself (type 'html')" |
|---|
| example | "<p>The terms of use!</p>" |
|---|
|
|---|
| type | | type | "string" |
|---|
| description | "Specifies the value type of the content property." |
|---|
| example | "html" |
|---|
| enum | |
|---|
|
|---|
|
|---|
| description | "The terms of use in specific languages." |
|---|
|
|---|
| TermsOfUseInfo | | type | "object" |
|---|
| properties | | active | | type | "boolean" |
|---|
| description | "Specifies whether terms of use are active or not. Active terms of use need to be accepted by users before first usage of the product or whenever terms are changed." |
|---|
| example | true |
|---|
|
|---|
| lastChangeTimestamp | | type | "string" |
|---|
| description | "The date and time of the last change of the terms of use, or null, if the terms of use have never been changed. Format: ISO 8601 with 'T' separator and numeric timezone." |
|---|
| nullable | true |
|---|
| example | "2020-10-09T11:51:46+02:00" |
|---|
|
|---|
| terms | | type | "array" |
|---|
| description | "The terms of use in specific languages." |
|---|
| items | | $ref | "#/components/schemas/TermsOfUse" |
|---|
|
|---|
|
|---|
|
|---|
| description | "Main data of the response." |
|---|
|
|---|
| Imprint | | type | "object" |
|---|
| properties | | content | | type | "string" |
|---|
| description | "Either an URL pointing to the imprint (type 'link') or the content itself (type 'html')." |
|---|
| example | "<h1>Imprint</h1><p>Lorem ipsum...</p>" |
|---|
|
|---|
| type | | type | "string" |
|---|
| description | "Specifies value type of the content property.." |
|---|
| example | "html" |
|---|
| enum | |
|---|
|
|---|
|
|---|
| description | "Main data of the response." |
|---|
|
|---|
| ResponseImprint | | type | "object" |
|---|
| properties | | data | | $ref | "#/components/schemas/Imprint" |
|---|
|
|---|
| meta | | type | "object" |
|---|
| additionalProperties | | type | "object" |
|---|
| description | "Additional response metadata." |
|---|
|
|---|
| description | "Additional response metadata." |
|---|
|
|---|
|
|---|
|
|---|
| LanguagePack | | type | "object" |
|---|
| properties | | id | | type | "string" |
|---|
| description | "Id of the language pack, contains locale and major version." |
|---|
| example | "en-US_2" |
|---|
|
|---|
| displayName | | type | "string" |
|---|
| description | "The display name of the language, in the respective language." |
|---|
| example | "English (US)" |
|---|
|
|---|
| locale | | type | "string" |
|---|
| description | "IETF BCP 47 language tag, RFC 5646. Format: <language>[-<region>]. Case insensitive." |
|---|
| example | "en-US" |
|---|
|
|---|
| version | | type | "string" |
|---|
| description | "The version of the language pack, consisting of major and minor version." |
|---|
| example | "2.1" |
|---|
|
|---|
| lastChangeTimestamp | | type | "string" |
|---|
| description | "The date and time of the last update of the language pack, or null, if it was never updated. Format: ISO 8601 with 'T' separator and numeric timezone." |
|---|
| nullable | true |
|---|
| example | "2020-10-09T11:51:46+02:00" |
|---|
|
|---|
| href | | type | "string" |
|---|
| description | "The absolute path to the language pack resources." |
|---|
| example | "/api/products/api.rest/language-packs/en-US_2" |
|---|
|
|---|
|
|---|
| description | "Main data of the response." |
|---|
|
|---|
| ResponseListLanguagePack | | type | "object" |
|---|
| properties | | data | | type | "array" |
|---|
| description | "Main data of the response." |
|---|
| items | | $ref | "#/components/schemas/LanguagePack" |
|---|
|
|---|
|
|---|
| meta | | type | "object" |
|---|
| additionalProperties | | type | "object" |
|---|
| description | "Additional response metadata." |
|---|
|
|---|
| description | "Additional response metadata." |
|---|
|
|---|
|
|---|
|
|---|
| ResponseLanguagePack | | type | "object" |
|---|
| properties | | data | | $ref | "#/components/schemas/LanguagePack" |
|---|
|
|---|
| meta | | type | "object" |
|---|
| additionalProperties | | type | "object" |
|---|
| description | "Additional response metadata." |
|---|
|
|---|
| description | "Additional response metadata." |
|---|
|
|---|
|
|---|
|
|---|
| CorsStatus | | type | "object" |
|---|
| properties | | active | | type | "boolean" |
|---|
| description | "Specifies whether CORS is active or not for requesting origin" |
|---|
| example | true |
|---|
|
|---|
|
|---|
| description | "Main data of the response." |
|---|
|
|---|
| ResponseCorsStatus | | type | "object" |
|---|
| properties | | data | | $ref | "#/components/schemas/CorsStatus" |
|---|
|
|---|
| meta | | type | "object" |
|---|
| additionalProperties | | type | "object" |
|---|
| description | "Additional response metadata." |
|---|
|
|---|
| description | "Additional response metadata." |
|---|
|
|---|
|
|---|
|
|---|
| MicrosoftGraphSettings | | type | "object" |
|---|
| properties | | applicationId | | type | "string" |
|---|
| description | "The application ID." |
|---|
|
|---|
| authority | | type | "string" |
|---|
| description | "The authority." |
|---|
|
|---|
|
|---|
| description | "Microsoft Graph settings." |
|---|
|
|---|
| OwaSettings | | type | "object" |
|---|
| properties | | microsoftGraphSettings | | $ref | "#/components/schemas/MicrosoftGraphSettings" |
|---|
|
|---|
|
|---|
| description | "Settings for Cryptshare for OWA." |
|---|
|
|---|
| ResponseOwaSettings | | type | "object" |
|---|
| properties | | data | | $ref | "#/components/schemas/OwaSettings" |
|---|
|
|---|
| meta | | type | "object" |
|---|
| additionalProperties | | type | "object" |
|---|
| description | "Additional response metadata." |
|---|
|
|---|
| description | "Additional response metadata." |
|---|
|
|---|
|
|---|
|
|---|
| ResponsePassword-Wrapper | | type | "object" |
|---|
| properties | | data | | $ref | "#/components/schemas/Password-Wrapper" |
|---|
|
|---|
| meta | | type | "object" |
|---|
| additionalProperties | | type | "object" |
|---|
| description | "Additional response metadata." |
|---|
|
|---|
| description | "Additional response metadata." |
|---|
|
|---|
|
|---|
|
|---|
| ResponseArrayListPasswordValidationRule | | type | "object" |
|---|
| properties | | data | | type | "array" |
|---|
| description | "Main data of the response." |
|---|
| items | | $ref | "#/components/schemas/PasswordValidationRule" |
|---|
|
|---|
|
|---|
| meta | | type | "object" |
|---|
| additionalProperties | | type | "object" |
|---|
| description | "Additional response metadata." |
|---|
|
|---|
| description | "Additional response metadata." |
|---|
|
|---|
|
|---|
|
|---|
| ClientId | | type | "object" |
|---|
| properties | | clientId | | type | "string" |
|---|
| description | "The ID that uniquely identifies the requesting client. Can also be specified by query parameter (client-id). Should be treated as confidential." |
|---|
|
|---|
|
|---|
| description | "Main data of the response." |
|---|
|
|---|
| ResponseClientId | | type | "object" |
|---|
| properties | | data | | $ref | "#/components/schemas/ClientId" |
|---|
|
|---|
| meta | | type | "object" |
|---|
| additionalProperties | | type | "object" |
|---|
| description | "Additional response metadata." |
|---|
|
|---|
| description | "Additional response metadata." |
|---|
|
|---|
|
|---|
|
|---|
| ResponseVoid | | type | "object" |
|---|
| properties | | data | | type | "object" |
|---|
| description | "Main data of the response." |
|---|
|
|---|
| meta | | type | "object" |
|---|
| additionalProperties | | type | "object" |
|---|
| description | "Additional response metadata." |
|---|
|
|---|
| description | "Additional response metadata." |
|---|
|
|---|
|
|---|
|
|---|