DRACOON API

Remove rooms's rescue key pair ### Description: Delete room rescue key pair. ### Precondition: Authenticated user. ### Postcondition: Key pair is removed (cf. further information below). ### Further Information: Please set a new room rescue key pair first and re-encrypt file keys with it. If no version is set, deleted key pair with lowest preference value. Although, `version` **SHOULD** be set.

Remove S3 tag ### Description: Delete S3 tag. ### Precondition: Right 🔓 change global config and role 👤 Config Manager of the Provider Customer required. ### Postcondition: S3 tag gets deleted. ### Further Information: None.

Remove system rescue key pair ### Description: Remove the system rescue key pair. ### Precondition: * Right 🔓 change config * Existence of own key pair ### Postcondition: Key pair is removed (cf. further information below). ### Further Information: Please set a new system rescue key pair first and re-encrypt file keys with it. If no version is set, deleted key pair with lowest preference value. Although, `version` **SHOULD** be set.

Remove tenant webhook ### Description: Delete a webhook for the tenant scope. ### Precondition: Right 🔓 manage webhook required. ### Postcondition: Webhook is deleted. ### Further Information: None.

Remove Upload Share ### Description: Delete an Upload Share (aka File Request). ### Precondition: User has 🔓 manage upload share permissions on target container. ### Postcondition: Upload Share is deleted. ### Further Information: Only the Upload Share is removed; already uploaded files and the target container persist.

Remove user ### Description: Delete a user. ### Precondition: Right 🔓 delete users required. ### Postcondition: User is deleted. ### Further Information: User **CANNOT** be deleted if he is a last room administrator of any room.

Remove custom user attribute ### Description: Delete custom user attribute. ### Precondition: Right 🔓 change users required. ### Postcondition: Custom user attribute is deleted. ### Further Information: * Allowed characters for keys are: `[a-zA-Z0-9_-]` * Characters are **case-insensitive**.

Remove user's key pair ### Description: Delete user key pair. ### Precondition: Authenticated user. ### Postcondition: Key pair is deleted. ### Further Information: If parameter `version` is not set and two key versions exist, this API deletes version A. If two keys with the same version are set, this API deletes the older one. This will also remove all file keys that were encrypted with the user public key. If the user had exclusive access to some files, those are removed as well since decrypting them became impossible.

Remove webhook ### Description: Delete a webhook for the customer scope. ### Precondition: Right 🔓 change config required. ### Postcondition: Webhook is deleted. ### Further Information: None.

Request S3 storage configuration ### Description: Retrieve S3 configuration. ### Precondition: Right 🔓 read global config and role 👤 Config Manager of the Provider Customer required. ### Postcondition: S3 configuration is returned. ### Further Information: None. ### Virtual hosted style access Example: https://bucket-name.s3.region.amazonaws.com/key-name

Request Active Directory authentication information ### Description: Provides information about Active Directory authentication options. ### Precondition: None. ### Postcondition: Active Directory authentication options information is returned. ### Further Information: None.

Request Active Directory configuration ### Description: Retrieve the configuration of an Active Directory. ### Precondition: Right 🔓 read global config of the Provider Customer required. ### Postcondition: Active Directory configuration is returned. ### Further Information: None.

Request list of Active Directory configurations ### Description: Retrieve a list of configured Active Directories. ### Precondition: Right 🔓 read global config of the Provider Customer required. ### Postcondition: List of Active Directory configurations is returned. ### Further Information: None.

Request all addable Datev MST tax years ### Description: Retrieve all addable Datev MST tax years. ### Precondition: Authenticated user. ### Postcondition: Datev MST addable tax years are returned. ### Further Information: None. ### Possible errors: Expand | Http Status | Error Code | Description | |:----------------------------|:-----------|:----------------------------| | `401 Forbidden` | `-90706` | Datev authorization invalid | | `500 Internal Server Error` | | System Error | | `502 Bad Gateway` | `-90701` | Datev communication failed |

Request algorithms ### Description: Retrieve a list of available algorithms used for encryption. ### Precondition: Authenticated user. ### Postcondition: List of available algorithms is returned. ### Further Information: None.

Request all system rescue key pairs ### Description: Retrieve all system rescue key pairs to allow migrating system-rescue-key-encrypted file keys. ### Precondition: * Right 🔓 change config * Existence of own key pair ### Postcondition: List of key pairs is returned. ### Further Information: In the case of an algorithm migration of a system rescue key, one should create the new key pair before deleting the old one. This allows re-encrypting file keys with the new key pair, using the old one. This API allows to retrieve both key pairs, in contrast to `GET /settings/keypair`, which only delivers the preferred one.

Request nodes ### Description: Retrieve a list of all nodes of type room under a certain parent. ### Precondition: Right 🔓 read audit log required. ### Postcondition: List of rooms. ### Further Information: For rooms on root level, use parent_id = 0. ### Filtering: All filter fields are connected via logical conjunction (**AND**) Filter string syntax: `FIELD_NAME:OPERATOR:VALUE[:VALUE...]` Example `nodeName:cn:searchString_1|nodeIsEncrypted:eq:true` Filter by node name containing `searchString_1` **AND** node is encrypted . ### Filtering options: Expand | `FIELD_NAME` | Filter Description | `OPERATOR` | Operator Description | `VALUE` | | :--- | :--- | :--- | :--- | :--- | | `nodeId` | Node ID filter | `eq` | Node ID equals value. | `positive Integer` | | `nodeName` | Node name filter | `cn, eq, sw` | Node name contains / equals / starts with value. | `search String` | | `nodeIsEncrypted` | Encrypted node filter | `eq` | | `true or false` | --- ### Sorting: Sort string syntax: `FIELD_NAME:ORDER` `ORDER` can be `asc` or `desc`. Multiple sort fields are supported. Example `nodeName:asc` Sort by `nodeName` ascending. ### Sorting options: Expand | `FIELD_NAME` | Description | | :--- | :--- | | `nodeId` | Node ID | | `nodeName` | Node name |

Request node assigned users with permissions ### Description: Retrieve a list of all nodes of type room, and the room assignment users with permissions. ### Precondition: Right 🔓 read audit log required. ### Postcondition: List of rooms and their assigned users is returned. ### Further Information: Output is limited to **500** entries. For more results please use filter criteria and the `limit` parameter. ### Filtering: All filter fields are connected via logical conjunction (**AND**) Except for `userName`, `userFirstName` and `userLastName` - these are connected via logical disjunction (**OR**) Filter string syntax: `FIELD_NAME:OPERATOR:VALUE[:VALUE...]` Example `userName:cn:searchString_1|userFirstName:cn:searchString_2|nodeId:eq:2` Filter by user login containing `searchString_1` **OR** first name containing `searchString_2` **AND** node ID equals `2`. ### Filtering options: Expand | `FIELD_NAME` | Filter Description | `OPERATOR` | Operator Description | `VALUE` | | :--- | :--- | :--- | :--- | :--- | | `nodeId` | Node ID filter | `eq` | Node ID equals value. | `positive Integer` | | `nodeName` | Node name filter | `cn, eq` | Node name contains / equals value. | `search String` | | `nodeParentId` | Node parent ID filter | `eq` | Parent ID equals value. | `positive Integer`Parent ID `0` is the root node. | | `userId` | User ID filter | `eq` | User ID equals value. | `positive Integer` | | `userName` | Username (login) filter | `cn, eq` | Username contains / equals value. | `search String` | | `userFirstName` | User first name filter | `cn, eq` | User first name contains / equals value. | `search String` | | `userLastName` | User last name filter | `cn, eq` | User last name contains / equals value. | `search String` | | `permissionsManage` | Filter the users that do (not) have `manage` permissions in this room | `eq` | | `true or false` | | `nodeIsEncrypted` | Encrypted node filter | `eq` | | `true or false` | | `nodeHasActivitiesLog` | Activities log filter | `eq` | | `true or false` | ### Deprecated filtering options: Expand | `FIELD_NAME` | Filter Description | `OPERATOR` | Operator Description | `VALUE` | | :--- | :--- | :--- | :--- | :--- | | `nodeHasRecycleBin` | Recycle bin filter**Filter has no effect!** | `eq` | | `true or false` | --- ### Sorting: Sort string syntax: `FIELD_NAME:ORDER` `ORDER` can be `asc` or `desc`. Multiple sort fields are supported. Example `nodeName:asc` Sort by `nodeName` ascending. ### Sorting options: Expand | `FIELD_NAME` | Description | | :--- | :--- | | `nodeId` | Node ID | | `nodeName` | Node name | | `nodeParentId` | Node parent ID | | `nodeSize` | Node size | | `nodeQuota` | Node quota |

Request authentication settings ### Description: DRACOON authentication configuration entry point. ### Precondition: Right 🔓 read global config and role 👤 Config Manager of the Provider Customer required. ### Postcondition: Returns a list of configurable authentication methods. ### Further Information: Authentication methods are sorted by priority attribute. Smaller values have higher priority. Authentication method with highest priority is considered as default. Priority **MUST** be a positive value. ### Configurable authentication settings: Expand | Authentication Method | Description | |:----------------------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | `basic` | **Basic** authentication globally allowed.This option **MUST** be activated to allow users to log in with their credentials stored in the database.Formerly known as `sql`. | | `active_directory` | **Active Directory** authentication globally allowed.This option **MUST** be activated to allow users to log in with their Active Directory credentials. | | `openid` | **OpenID Connect** authentication globally allowed.This option **MUST** be activated to allow users to log in with their OpenID Connect identity. |

Request avatar ### Description: Get the avatar. ### Precondition: Authenticated user. ### Postcondition: Avatar is returned. ### Further Information: None.

Request classification policies ### Description: Retrieve a list of classification policies: * `shareClassificationPolicies` ### Precondition: Right 🔓 read global config and role 👤 Config Manager of the Provider Customer required. ### Postcondition: List of configured classification policies is returned. ### Further Information: `classificationRequiresSharePassword`: When a node has this classification or higher, it cannot be shared without a password. If the node is an encrypted file this policy has no effect. `0` means no password will be enforced.

Request classification policies ### Description: Retrieve a list of classification policies: * `shareClassificationPolicies` ### Precondition: Authenticated user. ### Postcondition: List of configured classification policies is returned. ### Further Information: `classificationRequiresSharePassword`: When a node has this classification or higher, it cannot be shared without a password. If the node is an encrypted file this policy has no effect. `0` means no password will be enforced.

Request list of currently enabled product packages ### Description: Returns a list of currently enabled product packages. ### Precondition: Authenticated user ### Postcondition: List of currently enabled Product Packages is returned. ### Further Information:

Get customer ### Description: Receive details of a selected customer. ### Precondition: Authentication with `X-Sds-Service-Token` required. ### Postcondition: Customer details are returned. ### Further Information: None.

Request customer attributes ### Description: Retrieve a list of customer attributes. ### Precondition: Authentication with `X-Sds-Service-Token` required. Right 🔓 read all customers required. ### Postcondition: List of attributes is returned. ### Further Information: ### Filtering: Filters are case insensitive. All filter fields are connected via logical conjunction (**AND**) Filter string syntax: `FIELD_NAME:OPERATOR:VALUE[:VALUE...]` Example `key:cn:searchString_1|value:cn:searchString_2` Filter by attribute key contains `searchString_1` **AND** attribute value contains `searchString_2`. ### Filtering options: Expand | `FIELD_NAME` | Filter Description | `OPERATOR` | Operator Description | `VALUE` | | :--- | :--- | :--- | :--- | :--- | | `key` | Customer attribute key filter | `cn, eq, sw` | Attribute key contains / equals / starts with value. | `search String` | | `value` | Customer attribute value filter | `cn, eq, sw` | Attribute value contains / equals / starts with value. | `search String` | --- ### Sorting: Sort string syntax: `FIELD_NAME:ORDER` `ORDER` can be `asc` or `desc`. Multiple sort fields are supported. Example `key:asc|value:desc` Sort by `key` ascending **AND** by `value` descending. ### Sorting options: Expand | `FIELD_NAME` | Description | | :--- | :--- | | `key` | Customer attribute key | | `value` | Customer attribute value |

Request customer information for user ### Description: Use this API to get: * customer name * used / free space * used / available * user account info of the according customer. ### Precondition: Authenticated user. ### Postcondition: Customer information is returned. ### Further Information: None.

Request customer's key pair ### Use `GET /settings/keypair` API ### Description: Retrieve the customer rescue key pair. ### Precondition: Authenticated user. ### Postcondition: Key pair is returned. ### Further Information: The private key is password-based encrypted with `AES256` / `PBKDF2`.

Request list of customer users ### Description: Receive a list of users associated with a certain customer. ### Precondition: Authentication with `X-Sds-Service-Token` required. ### Postcondition: List of customer users is returned. ### Further Information: ### Filtering: All filter fields are connected via logical conjunction (**AND**) Except for `login`, `firstName` and `lastName` - these are connected via logical disjunction (**OR**) Filter string syntax: `FIELD_NAME:OPERATOR:VALUE[:VALUE...]` Example `login:cn:searchString_1|firstName:cn:searchString_2|lockStatus:eq:2` Filter users by login contains `searchString_1` **OR** firstName contains `searchString_2` **AND** those who are **NOT** locked. ### Filtering options: Expand | `FIELD_NAME` | Filter Description | `OPERATOR` | Operator Description | `VALUE` | | :--- | :--- | :--- | :--- | :--- | | `email` | Email filter | `eq`, `cn` | Email contains value. | `search String` | | `userName` | User name filter | `eq`, `cn` | UserName contains value. | `search String` | | `firstName` | User first name filter | `cn` | User first name contains value. | `search String` | | `lastName` | User last name filter | `cn` | User last name contains value. | `search String` | | `isLocked` | User lock status filter | `eq` | | `true or false` | | `effectiveRoles` | Filter users with DIRECT or DIRECT **AND** EFFECTIVE roles`false`: DIRECT roles`true`: DIRECT **AND** EFFECTIVE rolesDIRECT means: e.g. user gets role **directly** granted from someone with _grant permission_ right.EFFECTIVE means: e.g. user gets role through **group membership**. | `eq` | | `true or false`default: `false` | | `createdAt` | Creation date filter | `ge, le` | Creation date is greater / less equals than value.Multiple operator values are allowed and will be connected via logical conjunction (**AND**).e.g. `createdAt:ge:2016-12-31`|`createdAt:le:2018-01-01` | `Date (yyyy-MM-dd)` | | `phone` | Phone filter | `eq` | Phone equals value. | `search String` | | `isEncryptionEnabled` | Encryption status filterclient-side encryptionprivate key possession | `eq` | | `true or false` | | `hasRole` | (**`NEW`**) User role filterDepends on **effectiveRoles**.For more information about roles check **`GET /roles`** API | `eq`, `neq` | User role equals value. | `CONFIG_MANAGER` - Manages global configuration`USER_MANAGER` - Manages users`GROUP_MANAGER` - Manages user groups`ROOM_MANAGER` - Manages top level rooms`LOG_AUDITOR` - Reads audit logs`NONMEMBER_VIEWER` - Views users and groups when having room _"manage"_ permission`USER` - Regular User role`GUEST_USER` - Guest User role | ### Deprecated filtering options: Expand | `FIELD_NAME` | Filter Description | `OPERATOR` | Operator Description | `VALUE` | | :--- | :--- | :--- | :--- | :--- | | `lockStatus` | User lock status filter | `eq` | User lock status equals value. | `0` - Locked`1` - Web access allowed`2` - Web and mobile access allowed | | `login` | User login filter | `cn` | User login contains value. | `search String` | --- ### Sorting: Sort string syntax: `FIELD_NAME:ORDER` `ORDER` can be `asc` or `desc`. Multiple sort fields are supported. Example `firstName:asc|lastLoginSuccessAt:desc` Sort by `firstName` ascending **AND** by `lastLoginSuccessAt` descending. ### Sorting options: Expand | `FIELD_NAME` | Description | | :--- | :--- | | `userName` | User name | | `email` | User email | | `firstName` | User first name | | `lastName` | User last name | | `isLocked` | User lock status | | `lastLoginSuccessAt` | Last successful login date | | `expireAt` | Expiration date | | `createdAt` | Creation date | ### Deprecated sorting options: Expand | `FIELD_NAME` | Description | | :--- | :--- | | `gender` | Gender | | `lockStatus` | User lock status | | `login` | User login |

Request list of customers ### Description: Receive a list of customers. ### Precondition: Authentication with `X-Sds-Service-Token` required. ### Postcondition: List of customers is returned. ### Further Information: This list returns a maximum of **1000** entries. ### Filtering: All filter fields are connected via logical conjunction (**AND**) Filter string syntax: `FIELD_NAME:OPERATOR:VALUE[:VALUE...]` Example `trialDaysLeft:le:10|userMax:le:100` Get all customers with `10` trial days left **AND** user maximum ** ### Filtering options: Expand | `FIELD_NAME` | Filter Description | `OPERATOR` | Operator Description | `VALUE` | |:-----------------------|:----------------------------------|:------------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:------------------------------------------------------| | `id` | Customer ID filter | `eq` | Customer ID equals value. | `positive Integer` | | `companyName` | Company name filter | `cn` | Company name contains value. | `search String` | | `customerContractType` | Customer contract type filter | `eq` | Customer contract type equals value. | `demo``free``pay` | | `trialDaysLeft` | Left trial days filter | `ge, le` | Left trial days are greater / less equals than value.Multiple operator values are allowed and will be connected via logical conjunction (**AND**).e.g. `trialDaysLeft:ge:5`|`trialDaysLeft:le:10` | | | `providerCustomerId` | Provider Customer ID filter | `cn, eq` | Provider Customer ID contains / equals value. | `search String` | | `quotaMax` | Maximum quota filter | `ge, le` | Maximum quota is greater / less equals than value.Multiple operator values are allowed and will be connected via logical conjunction (**AND**).e.g. `quotaMax:ge:1024`|`quotaMax:le:1073741824` | `positive Integer` | | `quotaUsed` | Used quota filter | `ge, le` | Used quota is greater / less equals than value.Multiple operator values are allowed and will be connected via logical conjunction (**AND**).e.g. `quotaUsed:ge:1024`|`quotaUsed:le:1073741824` | `positive Integer` | | `userMax` | User maximum filter | `ge, le` | User maxiumum is greater / less equals than value.Multiple operator values are allowed and will be connected via logical conjunction (**AND**).e.g. `userMax:ge:10`|`userMax:le:100` | `positive Integer` | | `userUsed` | Number of registered users filter | `ge, le` | Number of registered users is is greater / less equals than value.Multiple operator values are allowed and will be connected via logical conjunction (**AND**).e.g. `userUsed:ge:10`|`userUsed:le:100` | `positive Integer` | | `isLocked` | Lock status filter | `eq` | | `true or false` | | `createdAt` | Creation date filter | `ge, le` | Creation date is greater / less equals than value.Multiple operator values are allowed and will be connected via logical conjunction (**AND**).e.g. `createdAt:ge:2016-12-31`|`createdAt:le:2018-01-01` | `Date (yyyy-MM-dd)` | | `updatedAt` | Last modification date filter | `ge, le` | Last modification date is greater / less equals than value.Multiple operator values are allowed and will be connected via logical conjunction (**AND**).e.g. `updatedAt:ge:2016-12-31`|`updatedAt:le:2018-01-01` | `Date (yyyy-MM-dd)` | | `lastLoginAt` | Last login date filter | `ge, le` | Last login date is greater / less equals than value.Multiple operator values are allowed and will be connected via logical conjunction (**AND**).e.g. `lastLoginAt:ge:2016-12-31`|`lastLoginAt:le:2018-01-01` | `Date (yyyy-MM-dd)` | | `userLogin` | User login filter | `eq` | User login name equals value.Search user all logins e.g. `basic`, `active_directory | `search String` | | `attributeKey` | Customer attribute key filter | `eq`, `nex` | Customer attribute key equals value / Customer attribute does **NOT** exist at customer | `search String` | | `attributeValue` | Customer attribute value filter | `eq` | Customer attribute value equals value. | `search String` | ### Deprecated filtering options: Expand | `FIELD_NAME` | Filter Description | `OPERATOR` | Operator Description | `VALUE` | | :--- | :--- | :--- | :--- | :--- | | `activationCode` | Activation code filter | `cn, eq` | Activation code contains / equals value. | `search String` | | `lockStatus` | Lock status filter | `eq` | | `0` - unlocked`1` - locked | --- ### Sorting: Sort string syntax: `FIELD_NAME:ORDER` `ORDER` can be `asc` or `desc`. Multiple sort criteria are possible. Fields are connected via logical conjunction **AND**. Example `companyName:desc|userUsed:asc` Sort by `companyName` descending **AND** `userUsed` ascending. ### Sorting options: Expand | `FIELD_NAME` | Description | | :--- | :--- | | `companyName` | Company name | | `customerContractType` | Customer contract type | | `trialDaysLeft` | Number of remaining trial days (demo customers) | | `providerCustomerId` | Provider Customer ID | | `quotaMax` | Maximum quota | | `quotaUsed` | Currently used quota | | `userMax` | Maximum user number | | `userUsed` | Number of registered users | | `isLocked` | Lock status of customer | | `createdAt` | Creation date | | `updatedAt` | Last modification date | | `lastLoginAt` | Last login date of any user of this customer | ### Deprecated sorting options: Expand | `FIELD_NAME` | Description | |:------------------------|:------------------------| | `lockStatus` | Lock status of customer |

Request Datev DUO sync configuration ### Description: Retrieve a Datev DUO sync configuration. ### Precondition: Authenticated user. ### Postcondition: Datev DUO sync configurations is returned. ### Further Information: None. ### Possible errors: Expand | Http Status | Error Code | Description | |:---|:---|:---| | `401 Forbidden` | `-90706` | Datev authorization invalid | | `500 Internal Server Error` | | System Error | | `502 Bad Gateway` | `-90701` | Datev communication failed |

Request list of Datev DUO sync configurations ### Description: Retrieve a list of Datev DUO sync configurations. ### Precondition: Authenticated user. ### Postcondition: List of Datev DUO sync configurations is returned. ### Further Information: None. ### Possible errors: Expand | Http Status | Error Code | Description | |:---|:---|:---| | `401 Forbidden` | `-90706` | Datev authorization invalid | | `500 Internal Server Error` | | System Error | | `502 Bad Gateway` | `-90701` | Datev communication failed |

Request information about a Datev DUO sync file ### Description: Retrieve a Datev DUO sync file. ### Precondition: Authenticated user. ### Postcondition: Datev DUO sync file is returned. ### Further Information: None. ### Possible errors: Expand | Http Status | Error Code | Description | |:---|:-----------|:--------------------------------------------| | `400 Bad Request` | `-90711` | File extension not allowed for Datev upload | | `400 Bad Request` | `-90712` | File too large for Datev upload | | `400 Bad Request` | `-90713` | Document type unknown by Datev | | `400 Bad Request` | `-90714` | Document not parseable by Datev | | `500 Internal Server Error` | | System Error |

Request information about Datev DUO sync files ### Description: Retrieve list of Datev DUO sync files. ### Precondition: Authenticated user. ### Postcondition: List of Datev DUO sync files is returned. ### Further Information: None. ### Possible errors: Expand | Http Status | Error Code | Description | |:---|:---|:---| | `400 Bad Request` | `-90711` | File extension not allowed for Datev upload | | `400 Bad Request` | `-90712` | File too large for Datev upload | | `500 Internal Server Error` | | System Error |

Request Datev MST sync configuration ### Description: Retrieve a Datev MST sync configuration. ### Precondition: Authenticated user. ### Postcondition: Datev MST sync configurations is returned. ### Further Information: None. ### Possible errors: Expand | Http Status | Error Code | Description | |:----------------------------|:-----------|:----------------------------| | `401 Forbidden` | `-90706` | Datev authorization invalid | | `500 Internal Server Error` | | System Error | | `502 Bad Gateway` | `-90701` | Datev communication failed |

Request list of Datev MST sync configurations ### Description: Retrieve a list of Datev MST sync configurations. ### Precondition: Authenticated user. ### Postcondition: List of Datev MST sync configurations is returned. ### Further Information: None. ### Possible errors: Expand | Http Status | Error Code | Description | |:----------------------------|:-----------|:----------------------------| | `401 Forbidden` | `-90706` | Datev authorization invalid | | `500 Internal Server Error` | | System Error | | `502 Bad Gateway` | `-90701` | Datev communication failed |

Request information about a Datev MST sync file ### Description: Retrieve a Datev MST sync file. ### Precondition: Authenticated user. ### Postcondition: Datev MST sync file is returned. ### Further Information: None. ### Possible errors: Expand | Http Status | Error Code | Description | |:----------------------------|:-----------|:--------------------------------------------| | `400 Bad Request` | `-90711` | File extension not allowed for Datev upload | | `400 Bad Request` | `-90712` | File too large for Datev upload | | `400 Bad Request` | `-90713` | Document type unknown by Datev | | `400 Bad Request` | `-90714` | Document not parseable by Datev | | `500 Internal Server Error` | | System Error |

Request information about Datev MST sync files ### Description: Retrieve list of Datev MST sync files. ### Precondition: Authenticated user. ### Postcondition: List of Datev MST sync files is returned. ### Further Information: None. ### Possible errors: Expand | Http Status | Error Code | Description | |:----------------------------|:-----------|:--------------------------------------------| | `400 Bad Request` | `-90711` | File extension not allowed for Datev upload | | `400 Bad Request` | `-90712` | File too large for Datev upload | | `500 Internal Server Error` | | System Error |

Request Datev sync configuration for room ### Description: Retrieve a Datev sync configuration for a given room. ### Precondition: Authenticated user. ### Postcondition: Datev DUO or MST sync configuration is returned. ### Further Information: None. ### Possible errors: Expand | Http Status | Error Code | Description | |:----------------------------|:-----------|:----------------------------| | `401 Forbidden` | `-90706` | Datev authorization invalid | | `500 Internal Server Error` | | System Error | | `502 Bad Gateway` | `-90701` | Datev communication failed |

Request deleted node ### Description: Get metadata of a deleted node. ### Precondition: User can access parent room and has 🔓 read recycle bin permissions. ### Postcondition: Requested deleted node is returned. ### Further Information: None.

Request deleted versions of nodes ### Description: Retrieve all deleted versions of a node. ### Precondition: User can access parent room and has 🔓 read recycle bin permissions. ### Postcondition: List of deleted versions of a node is returned. ### Further Information: The node is identified by three parameters: * parent ID * name * type (file, folder). Sort string syntax: `FIELD_NAME:ORDER` `ORDER` can be `asc` or `desc`. Multiple sort criteria are possible. Fields are connected via logical conjunction **AND**. Example `expireAt:desc|size:asc` Sort by `expireAt` descending **AND** `size` ascending. ### Sorting options: Expand | `FIELD_NAME` | Description | | :--- | :--- | | `expireAt` | Expiration date | | `accessedAt` | Last access date | | `size` | Node size | | `classification` | Classification ID:1 - public2 - internal3 - confidential4 - strictly confidential | | `createdAt` | Creation date | | `createdBy` | Creator first name, last name | | `updatedAt` | Last modification date | | `updatedBy` | Last modifier first name, last name | | `deletedAt` | Deleted date | | `deletedBy` | Deleter first name, last name |

Request list of deleted nodes ### Description: Retrieve a list of deleted nodes in a recycle bin. ### Precondition: User can access parent room and has 🔓 read recycle bin permissions. ### Postcondition: List of deleted nodes is returned. ### Further Information: Only room IDs are accepted as parent ID since only rooms may have a recycle bin. ### Filtering: All filter fields are connected via logical conjunction (**AND**) Filter string syntax: `FIELD_NAME:OPERATOR:VALUE[:VALUE...]` Example `type:eq:file:folder|name:cn:searchString_1|parentPath:cn:searchString_2` Get deleted nodes where type equals (`file` **OR** `folder`) **AND** deleted node name containing `searchString_1` **AND** deleted node parent path containing `searchString 2`. ### Filtering options: Expand | `FIELD_NAME` | Filter Description | `OPERATOR` | Operator Description | `VALUE` | | :--- | :--- | :--- | :--- | :--- | | `type` | Node type filter | `eq` | Node type equals value(s).Multiple values are allowed and will be connected via logical disjunction (**OR**).e.g. `type:eq:folder:file` | `folder``file` | | `name` | Node name filter | `cn` | Node name contains value. | `search String` | | `parentPath` | Parent path filter | `cn` | Parent path contains value. | `search String` | | `timestampCreation` | Creation timestamp filter | `ge, le` | Creation timestamp is greater / less equals than value.Multiple operator values are allowed and will be connected via logical conjunction (**AND**).e.g. `timestampCreation:ge:2016-12-31`|`timestampCreation:le:2018-01-01` | `Date (yyyy-MM-dd)` | | `timestampModification` | Modification timestamp filter | `ge, le` | Modification timestamp is greater / less equals than value.Multiple operator values are allowed and will be connected via logical conjunction (**AND**).e.g. `timestampModification:ge:2016-12-31T23:00:00.123`|`timestampModification:le:2018-01-01T11:00:00.540` | `Date (yyyy-MM-dd)` | --- ### Sorting: Sort string syntax: `FIELD_NAME:ORDER` `ORDER` can be `asc` or `desc`. Multiple sort criteria are possible. Fields are connected via logical conjunction **AND**. Nodes are sorted by type first, then by sent sort string. Example `name:desc|timestampCreation:asc` Sort by `name` descending **AND** `timestampCreation` ascending. ### Sorting options: Expand | `FIELD_NAME` | Description | | :--- | :--- | | `name` | Node name | | `cntVersions` | Number of deleted versions of this file | | `firstDeletedAt` | First deleted version | | `lastDeletedAt` | Last deleted version | | `parentPath` | Parent path of deleted node | | `timestampCreation` | Creation timestamp | | `timestampModification` | Modification timestamp |

Request Download Share ### Description: Retrieve detailed information about one Download Share. ### Precondition: User with 🔓 manage download share permissions on target node. ### Postcondition: Download Share is returned ### Further Information: None.

Request Download Share via QR Code ### Description: Retrieve detailed information about one Download Share. ### Precondition: User with 🔓 manage download share permissions on target node. ### Postcondition: Download Share is returned ### Further Information: None.

Request list of Download Shares ### Description: Retrieve a list of Download Shares. ### Precondition: Authenticated user. ### Postcondition: List of available Download Shares is returned. ### Further Information: ### Filtering: All filter fields are connected via logical (**AND**). createdBy and updatedBy searches several user-related attributes. Filter string syntax: `FIELD_NAME:OPERATOR:VALUE[:VALUE...]` Example `name:cn:searchString_1|createdBy:cn:searchString_2` Filter by file name contains `searchString_1` **AND** creator info (`firstName` **OR** `lastName` **OR** `email` **OR** `username`) contains `searchString_2`. ### Filtering options: Expand | `FIELD_NAME` | Filter Description | `OPERATOR` | Operator Description | `VALUE` | | :--- | :--- | :--- | :--- | :--- | | `name` | Alias or node name filter | `cn` | Alias or node name contains value. | `search String` | | `createdAt` | Creation date filter | `ge, le` | Creation date is greater / less equals than value.Multiple operator values are allowed and will be connected via logical conjunction (**AND**).e.g. `createdAt:ge:2016-12-31`|`createdAt:le:2018-01-01` | `Date (yyyy-MM-dd)` | | `createdBy` | Creator info filter | `cn, eq` | Creator info (`firstName` **OR** `lastName` **OR** `email` **OR** `username`) contains value. | `search String` | | `createdById` | Creator ID filter | `eq` | Creator ID equals value. | `positive Integer` | | `accessKey` | Share access key filter | `cn` | Share access key contains values. | `search String` | | `nodeId` | Source node ID | `eq` | Source node (room, folder, file) ID equals value. | `positive Integer` | | `updatedBy` | Modifier info filter | `cn, eq` | Modifier info (`firstName` **OR** `lastName` **OR** `email` **OR** `username`) contains value. | `search String` | | `updatedById` | Modifier ID filter | `eq` | Modifier ID equals value. | `positive Integer` | ### Deprecated filtering options: Expand | `FIELD_NAME` | Filter Description | `OPERATOR` | Operator Description | `VALUE` | | :--- | :--- | :--- | :--- | :--- | | `userId` | Creator user ID | `eq` | Creator user ID equals value. Use `createdById` instead | `positive Integer` | --- ### Sorting: Sort string syntax: `FIELD_NAME:ORDER` `ORDER` can be `asc` or `desc`. Multiple sort fields are supported. Example `name:asc|expireAt:desc` Sort by `name` ascending **AND** by `expireAt` descending. ### Sorting options: Expand | `FIELD_NAME` | Description | | :--- | :--- | | `name` | Alias or node name | | `notifyCreator` | Notify creator on every download | | `expireAt` | Expiration date | | `createdAt` | Creation date | | `createdBy` | Creator first name, last name | | `classification` | Classification ID:1 - public2 - internal3 - confidential4 - strictly confidential |

Request emergency MFA code ### Description: Request emergency MFA code for a specific user. ### Precondition: Right 🔓 change users required. ### Postcondition: Emergency MFA code is returned. ### Further Information: Emergency code can be used instead of standard MFA authentication to disable all MFA setups.

Request eventlog settings ### Description: DRACOON eventlog configuration entry point. ### Precondition: Right 🔓 read global config and role 👤 Config Manager of the Provider Customer required. ### Postcondition: Returns a list of configurable eventlog settings. ### Further Information: None. ### Configurable eventlog settings: Expand | Setting | Description | Value | | :--- | :--- | :--- | | `enabled` | Determines whether eventlog is enabled. | `true or false` | | `retentionPeriod` | Retention period (in _days_) of eventlog entries.After that period, all entries are deleted. | `Integer between 0 and 9999`If set to `0`: no logs are deleted | | `logIpEnabled` | Determines whether user’s IP address is logged. | `true or false` |

Request list of file versions ### Description: Request a list of file versions. Both nodes and deleted nodes are included, depending on the user's permissions. ### Precondition: User has 🔓 read/read recycle bin permissions in parent room. ### Postcondition: List of file versions is returned. ### Further Information: Maximum number of file versions is 500. The list is sorted by ID DESC.

Request general settings ### Description: DRACOON general settings configuration entry point. ### Precondition: Right 🔓 read global config and role 👤 Config Manager of the Provider Customer required. ### Postcondition: Returns a list of configurable general settings. ### Further Information: ### Auth token restrictions: A restriction is a lower bound for a token timeout and defines a duration after which a token is invalidated when it wasn't used. The access/refresh token validity duration of the client is the upper bound. A token is invalidated - in any case - when it has passed. Auth token restrictions are enabled by default. * Default access token validity: **2 hours** * Default refresh token validity: **30 days** ### Configurable general settings: Expand | Setting | Description | Value | | :--- | :--- | :--- | | `sharePasswordSmsEnabled` | Determines whether sending of share passwords via SMS is allowed. | `true or false` | | `cryptoEnabled` | Determines whether client-side encryption is enabled.Can only be enabled once; disabling is **NOT** possible. | `true or false` | | `emailNotificationButtonEnabled` | Determines whether email notification button is enabled. | `true or false` | | `eulaEnabled` | Determines whether EULA is enabled.Each user has to confirm the EULA at first login. | `true or false` | | `useS3Storage` | Defines if S3 is used as storage backend.Can only be enabled once; disabling is **NOT** possible. | `true or false` | | `s3TagsEnabled` | Determines whether S3 tags are enabled | `true or false` | | `authTokenRestrictions` | Determines auth token restrictions. (e.g. restricted access token validity) | `object` | ### Deprecated configurable general settings: Expand | Setting | Description | Value | |:----------------------------------| :--- | :--- | | `mediaServerEnabled` | Determines whether media server is enabled.Returns boolean value dependent on conjunction of `mediaServerConfigEnabled` AND `mediaServerEnabled` | `true or false` | | `weakPasswordEnabled` | Determines whether weak password is allowed.Use `GET /system/config/policies/passwords` API to get configured password policies. | `true or false` | | `hideLoginInputFields` | Determines whether input fields for login should be enabled | `true or false` |

Request general settings ### Description: Returns a list of configurable general settings. ### Precondition: Authenticated user. ### Postcondition: List of configurable general settings is returned. ### Further Information: None. ### Configurable general settings: Expand | Setting | Description | Value | |:---------------------------------|:------------------------------------------------------------------------------------------------------------------|:----------------| | `sharePasswordSmsEnabled` | Determines whether sending of share passwords via SMS is allowed. | `true or false` | | `cryptoEnabled` | Determines whether client-side encryption is enabled.Can only be enabled once; disabling is **NOT** possible. | `true or false` | | `emailNotificationButtonEnabled` | Determines whether email notification button is enabled. | `true or false` | | `eulaEnabled` | Determines whether EULA is enabled.Each user has to confirm the EULA at first login. | `true or false` | | `useS3Storage` | Defines if S3 is used as storage backend.Can only be enabled once; disabling is **NOT** possible. | `true or false` | | `s3TagsEnabled` | Determines whether S3 tags are enabled | `true or false` | | `homeRoomsActive` | Determines whether each AD user has a personal home room | `true or false` | | `homeRoomParentId` | Defines a node under which all personal home rooms are located. **NULL** if `homeRoomsActive` is `false` | `Long` | | `subscriptionPlan` | Subscription Plan. 0 = Pro, 1 = Premium, 2 = Basic | `Integer` | | `authTokenRestrictions` | Determines auth token restrictions. (e.g. restricted access token validity) | `object` | ### Deprecated general settings: Expand | Setting | Description | Value | |:----------------------------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------|:----------------| | `mediaServerEnabled` | Determines whether media server is enabled.Returns boolean value dependent on conjunction of `mediaServerConfigEnabled` AND `mediaServerEnabled` | `true or false` | | `weakPasswordEnabled` | Determines whether weak password is allowed.Use `GET /system/config/policies/passwords` API to get configured password policies. | `true or false` | | `hideLoginInputFields` | Determines whether input fields for login should be enabled | `true or false` |

Request user group ### Description: Retrieve detailed information about a user group. ### Precondition: Right 🔓 read groups required. ### Postcondition: User group is returned. ### Further Information: None.