DRACOON API

Mark a node (room, folder or file) as favorite ### Description: Marks a node (room, folder or file) as favorite. ### Precondition: Authenticated user is allowed to 👁 see the node (i.e. `isBrowsable = true`). ### Postcondition: A node gets marked as favorite. ### Further Information: None.

Add group members ### Description: Add members to a group. ### Precondition: Right 🔓 change groups required. ### Postcondition: New members are added to the group. ### Further Information: Batch function. The newly provided members will be added to the existing ones.

Assign group(s) to the role ### Description: Assign group(s) to a role. ### Precondition: Right 🔓 grant permission on desired role required. ### Postcondition: One or more groups will be added to a role. ### Further Information: None.

Assign user(s) to the role ### Description: Assign user(s) to a role. ### Precondition: Right 🔓 grant permission on desired role required. ### Postcondition: One or more users will be added to a role. ### Further Information: None.

Add guest users to a room ### Description: Add guest users to a room ### Precondition: User needs to be a 👤 Room Administrator. To add new members, the user needs the right 🔓 non-members add, which is included in any role. 👤 Guest User Policy needs to be enabled. ### Postcondition: New or existing Guest-Users now have guest-permissions for this room ### Further Information: Batch function.

Cancel file upload ### Description: Cancel a (S3) file upload and destroy the upload channel. ### Precondition: An upload channel has been created and user has to be the creator of the upload channel. ### Postcondition: The upload channel is removed and all temporary uploaded data is purged. ### Further Information: It is recommended to notify the API about cancelled uploads if possible.

Cancel file upload ### Description: Cancel file upload. ### Precondition: Valid upload token. ### Postcondition: Upload canceled, token invalidated and all already transfered chunks removed. ### Further Information: It is recommended to notify the API about cancelled uploads if possible.

Cancel file upload ### Description: Abort (chunked) upload via Upload Share. ### Precondition: Valid Upload ID. ### Postcondition: Aborts upload and invalidates upload ID / token. ### Further Information: None.

Change classification policies ### Description: Change current classification policies: * `shareClassificationPolicies` ### Precondition: Right 🔓 change global config and role 👤 Config Manager of the Provider Customer required. ### Postcondition: Classification policies are changed. ### 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.

Change guest user policies ### Description: Change current guest user policies. ### Precondition: Right 🔓 change global config and role 👤 Config Manager of the Provider Customer required. ### Postcondition: Guest user policies are changed. ### Further Information: None.

Change MFA policies ### Description: Change current multi-factor authentication policies. ### Precondition: Right 🔓 change global config and role 👤 Config Manager of the Provider Customer required. ### Postcondition: Multi-factor authentication policies are changed. ### Further Information: None.

Change MFA policies for internal/external users ### Description: Change current multi-factor authentication policies for all users of specific user type. ### Precondition: Right 🔓 change global config and role 👤 Config Manager of the Provider Customer required. ### Postcondition: Multi-factor authentication policies are changed for all users of specific user type. ### Further Information: None.

Change password policies ### Description: Change current password policies for any password types: * `login` * `shares` * `encryption` ### Precondition: Right 🔓 change global config and role 👤 Config Manager of the Provider Customer required. ### Postcondition: Password policies get changed. ### Further Information: None. ### Available password policies: Expand | Name | Description | Value | Recommended Value | Password Type | | :--- | :--- | :--- | :--- | :--- | | `mustContainCharacters` | Characters which a password must contain:`alpha` - at least one alphabetical character (`uppercase` **OR** `lowercase`)a b c d e f g h i j k l m n o p q r s t u v w x y zA B C D E F G H I J K L M N O P Q R S T U V W X Y Z`uppercase` - at least one uppercase characterA B C D E F G H I J K L M N O P Q R S T U V W X Y Z`lowercase` - at least one lowercase charactera b c d e f g h i j k l m n o p q r s t u v w x y z`numeric` - at least one numeric character0 1 2 3 4 5 6 7 8 9`special` - at least one special character (letters and digits excluded)! " # $ % ( ) * + , - . / : ; = ? @ [ \ ] ^ _ { | } ~`none` - none of the above`all` - combination of `uppercase`, `lowercase`, `numeric` and `special` | `alpha``uppercase``lowercase``numeric``special``none``all` | `uppercase``lowercase``numeric` | `login``shares``encryption` | | `numberOfCharacteristicsToEnforce` | Number of characteristics to enforce.e.g. from `["uppercase", "lowercase", "numeric", "special"]`all 4 character sets can be enforced; but also only 2 of them | `Integer between 0 and 4`default:`none` - `0``all` - `4`otherwise - amount of distinct valuescf. `mustContainCharacters` matrix | `3` | `login``shares``encryption` | | `minLength` | Minimum number of characters a password must contain. | `login`: `Integer between 1 and 1024``shares`: `Integer between 1 and 72``encryption`: `Integer between 1 and 1024` | `login`: `12``shares`: `12``encryption`: `14` | `login``shares``encryption` | | `rejectDictionaryWords` | Determines whether a password must **NOT** contain word(s) from a dictionary.In `core-service.properties` a path to directory with dictionary files (`*.txt`) can be definedcf. `policies.passwords.dictionary.directory`.If this rule gets enabled `policies.passwords.dictionary.directory` must be defined and contain dictionary files.Otherwise, the rule will not have any effect on password validation process. | `true or false` | `true` | `login``shares` | | `rejectUserInfo` | Determines whether a password must **NOT** contain user info.Affects user's **first name**, **last name**, **email** and **user name**. | `true or false` | `true` | `login``shares``encryption` | | `rejectKeyboardPatterns` | Determines whether a password must **NOT** contain keyboard patterns.e.g. `qwertz`, `asdf` (min. 4 character pattern) | `true or false` | `true` | `login``shares``encryption` | | `numberOfArchivedPasswords` | Number of passwords to archive. | `Integer between 0 and 10`Set `0` to disable password history. | `3` | `login` | | `passwordExpiration.enabled` | Determines whether password expiration is enabled.Password expiration policy can only be enabled in context with `enforceLoginPasswordChange`. | `true or false` | `false` | `login` | | `maxPasswordAge` | Maximum allowed password age (in **days**) | `positive Integer` | | `login` | | `userLockout.enabled` | Determines whether user lockout is enabled. | `true or false` | `true` | `login` | | `maxNumberOfLoginFailures` | Maximum allowed number of failed login attempts. | `positive Integer` | `5` | `login` | | `lockoutPeriod` | Amount of **minutes** a user has to wait to make another login attemptafter `maxNumberOfLoginFailures` has been exceeded. | `positive Integer` | `10` | `login` | ### Deprecated password policies: Expand | Name | Description | Value | Recommended Value | Password Type | | :--- | :--- | :--- | :--- | :--- | | `enforceLoginPasswordChange` | Determines whether a login password change should be enforced for all users.Only takes effect, if login password policies get stricter.Use `POST /system/config/policies/passwords/enforce_change` API to enforce a login password change. | `true or false`default: `false` | | `login` | ### `mustContainCharacters` matrix: Expand | | `alpha` | `uppercase` | `lowercase` | `numeric` | `special` | `all` | `none` | | :---: | :---: | :---: | :---: | :---: | :---: | :---: | :---: | | `alpha` | `alpha` | `uppercase` | `lowercase` | `alpha``numeric` | `alpha``special` | `all` | `none` | | `uppercase` | `uppercase` | `uppercase` | `uppercase``lowercase` | `uppercase``numeric` | `uppercase``special` | `all` | `none` | | `lowercase` | `lowercase` | `uppercase``lowercase` | `lowercase` | `lowercase``numeric` | `lowercase``special` | `all` | `none` | | `numeric` | `alpha``numeric` | `uppercase``numeric` | `lowercase``numeric` | `numeric` | `numeric``special` | `all` | `none` | | `special` | `alpha``special` | `uppercase``special` | `lowercase``special` | `numeric``special` | `special` | `all` | `none` | | `all` | `all` | `all` | `all` | `all` | `all` | `all` | `none` | | `none` | `none` | `none` | `none` | `none` | `none` | `none` | `none` |

Handle user-room assignments per group ### Description: Handles a list of user-room assignments by groups that have **NOT** been approved yet **WAITING** or **DENIED** assignments can be **ACCEPTED**. ### Precondition: None. ### Postcondition: User-room assignment is approved and the user gets access to the group. ### Further Information: Room administrators should **SHOULD** handle pending assignments to provide access to rooms for other users.

Change user's password ### Description: Change the user's password. ### Precondition: Authenticated user. ### Postcondition: User's password is changed. ### Further Information: The password **MUST** comply to configured password policies. Forbidden characters in passwords: [`&`, `'`, ``]

Change virus protection policies ### Description: Change current virus protection policy. ### Precondition: Right 🔓 change global config and role 👤 Config Manager of the Provider Customer required. ### Postcondition: Virus Protection policy is changed. ### Further Information: None.

Check public Download Share password ### Description: Check password for a public Download Share ### Precondition: None. ### Postcondition: None. ### Further Information: None.

Complete Datev DUO authorization ### Description: Complete the OAuth authorization for Datev DUO to configure Datev DUO sync for a room. ### Precondition: User needs to be a 👤 Room Administrator. ### Postcondition: A OAuth authorization for Datev DUO is completed and a Datev sync configuration is created/updated. ### Further Information: None.

Complete Datev MST authorization ### Description: Complete the OAuth authorization for Datev MST to configure Datev MST sync for a room. ### Precondition: User needs to be a 👤 Room Administrator. ### Postcondition: A OAuth authorization for Datev MST is completed and a Datev sync configuration is created/updated. ### Further Information: None.

Complete file upload ### Use `uploads` API ### Description: Finishes an upload and closes the corresponding upload channel. ### Precondition: An upload channel has been created and data has been transmitted. ### Postcondition: The upload is finished and the temporary file is moved to the productive environment. ### Further Information: The provided file name might be changed in accordance with the resolution strategy: * **autorename**: changes the file name and adds a number to avoid conflicts. * **overwrite**: deletes any old file with the same file name. * **fail**: returns an error; in this case, another `PUT` request with a different file name may be sent. Please ensure that all chunks have been transferred correctly before finishing the upload. Download share id (if exists) gets changed if: - node with the same name exists in the target container - `resolutionStrategy` is `overwrite` - `keepShareLinks` is `true` ### Node naming convention: * Node (room, folder, file) names are limited to **150** characters. * Illegal names: `'CON', 'PRN', 'AUX', 'NUL', 'COM1', 'COM2', 'COM3', 'COM4', 'COM5', 'COM6', 'COM7', 'COM8', 'COM9', 'LPT1', 'LPT2', 'LPT3', 'LPT4', 'LPT5', 'LPT6', 'LPT7', 'LPT8', 'LPT9', (and any of those with an extension)` * Illegal characters in names: `'\\', '', ':', '\"', '|', '?', '*', '/', leading '-', trailing '.' `

Complete file upload ### Description: Finish uploading a file. ### Precondition: Valid upload token. ### Postcondition: File created. ### Further Information: The provided file name might be changed in accordance with the resolution strategy: * **autorename**: changes the file name and adds a number to avoid conflicts. * **overwrite**: deletes any old file with the same file name. * **fail**: returns an error; in this case, another `PUT` request with a different file name may be sent. Please ensure that all chunks have been transferred correctly before finishing the upload. Download share id (if exists) gets changed if: - node with the same name exists in the target container - `resolutionStrategy` is `overwrite` - `keepShareLinks` is `true`

Complete file upload ### Description: Finalize (chunked) upload via Upload Share. ### Precondition: Valid upload ID. Only returns users that owns one of the following permissions: 🔓 manage, 🔓 read, 🔓 manage download share, 🔓 manage upload share ### Postcondition: Finalizes upload. ### Further Information: Chunked uploads (range requests) are supported. Please ensure that all chunks have been transferred correctly before finishing the upload. If file hash has been created in time a `201 Created` will be responded and hash will be part of response, otherwise it will be a `202 Accepted` without it.

Complete S3 file upload ### Description: Finishes a S3 file upload and closes the corresponding upload channel. ### Precondition: An upload channel has been created, data has been transmitted and user has to be the creator of the upload channel ### Postcondition: Upload channel is closed. S3 multipart upload request is completed. ### Further Information: Download share id (if exists) gets changed if: - node with the same name exists in the target container - `resolutionStrategy` is `overwrite` - `keepShareLinks` is `true`

Complete S3 file upload ### Description: Finishes a S3 file upload and closes the corresponding upload channel. ### Precondition: Valid upload ID. Only returns users that owns one of the following permissions: 🔓 manage, 🔓 read, 🔓 manage download share, 🔓 manage upload share ### Postcondition: Upload channel is closed. S3 multipart upload request is completed. ### Further Information: None.

Configure room ### Description: Configure a room. ### Precondition: User needs to be a 👤 Room Administrator. ### Postcondition: Room's configuration is changed. ### Further Information: Provided (or default) classification is taken from room when file gets uploaded without any classification. To set `adminIds` or `adminGroupIds` the `inheritPermissions` value has to be `false`. Otherwise use: * `PUT /nodes/rooms/{room_id}/groups` * `PUT /nodes/rooms/{room_id}/users ` APIs.

Confirm second factor TOTP setup with a generated OTP ### Description: Confirm second factor TOTP setup with a generated OTP. ### Precondition: Authenticated user ### Postcondition: Second factor TOTP is enabled. ### Further Information: None.

Copy node(s) ### Description: Copies nodes (folder, file) to another parent. ### Precondition: Authenticated user with 🔓 read permissions in the source parent and 🔓 create permissions in the target parent node. ### Postcondition: Nodes are copied to target parent. ### Further Information: Nodes **MUST** be in same source parent. **Rooms **CANNOT** be copied.** Download share id (if exists) gets changed if: - node with the same name exists in the target container - `resolutionStrategy` is `overwrite` - `keepShareLinks` is `true` ### Node naming convention: * Node (room, folder, file) names are limited to **150** characters. * Illegal names: `'CON', 'PRN', 'AUX', 'NUL', 'COM1', 'COM2', 'COM3', 'COM4', 'COM5', 'COM6', 'COM7', 'COM8', 'COM9', 'LPT1', 'LPT2', 'LPT3', 'LPT4', 'LPT5', 'LPT6', 'LPT7', 'LPT8', 'LPT9', (and any of those with an extension)` * Illegal characters in names: `'\\', '', ':', '\"', '|', '?', '*', '/', leading '-', trailing '.' `

Create Active Directory configuration ### Description: Create a new Active Directory configuration. ### Precondition: Right 🔓 change global config of the Provider Customer required. ### Postcondition: New Active Directory configuration created. ### Further Information: None.

Create system rescue key pair and preserve copy of old private key ### Description: Create system rescue key pair and preserve copy of old private key. ### Precondition: * Right 🔓 change config * Existence of own key pair ### Postcondition: System rescue key pair is created. Copy of old private key is preserved. ### Further Information: You can submit your old private key, encrypted with your current password. This allows migrating file keys encrypted with your old key pair to the new one.

Create key pair and preserve copy of old private key ### Description: Create room rescue key pair and preserve copy of old private key. ### Precondition: User needs to be a 👤 Room Administrator. ### Postcondition: Room rescue key pair is created. Copy of old private key is preserved. ### Further Information: You can submit your old private key, encrypted with your current password. This allows migrating file keys encrypted with your old key pair to the new one.

Create key pair and preserve copy of old private key ### Description: Create user key pair and preserve copy of old private key. ### Precondition: Authenticated user. ### Postcondition: Key pair is created. Copy of old private key is preserved. ### Further Information: You can submit your old private key, encrypted with your current password. This allows migrating file keys encrypted with your old key pair to the new one.

Create customer ### Description: Create a new customer. ### Precondition: Authentication with `X-Sds-Service-Token` required. ### Postcondition: A new customer is created. ### Further Information: If no company name is set, first letter of the first name separated by dot followed by last name of the first administrator is used (e.g. `J.Doe`). Max quota has to be at least `1 MB` (= `1.048.576 B`). If `basic` authentication is enabled, the first administrator will get `basic` authentication by default. To create a first administrator without `basic` authentication it **MUST** be disabled explicitly. Forbidden characters in passwords: [`&`, `'`, ``] Forbidden characters in usernames: [``] ### Authentication Method Options: Expand | Authentication Method | Option Key | Option Value | |:----------------------|:---------------------------------------------------------------------------|:---------------------------------------------------------------------------| | `basic` / `sql` | `username` | Unique user identifier | | `active_directory` | `ad_config_id` (optional) | Active Directory configuration ID | | `username` | Active Directory username according to authentication setting `userFilter` | | | `openid` | `openid_config_id` (optional) | OpenID Connect configuration ID | | | `username` | OpenID Connect username according to authentication setting `mappingClaim` |

Create new Download Share ### Description: Create a new Download Share. ### Precondition: User with 🔓 manage download share permissions on target node. ### Postcondition: Download Share is created. ### Further Information: If the target node is a room: subordinary rooms are excluded from a Download Share. * `name` is limited to **150** characters. * `notes` are limited to **255** characters. * `password` is limited to **72** characters. Use `POST /shares/downloads/{share_id}/email` API for sending emails. Forbidden characters in passwords: [`&`, `'`, ``]. Forbidden characters in share names: [``]. Please keep in mind that due to various restrictions of different telecommunication providers, non-ASCII characters may not be displayed correctly in short messages (SMS).

Create new file upload channel ### Description: This endpoint creates a new upload channel which is the first step in any file upload workflow. ### Precondition: User has 🔓 create permissions in the parent container (room or folder). ### Postcondition: A new upload channel for a file is created. Its ID and an upload token are returned. ### Further Information: The upload ID is used for uploads with `Authorization` header, the upload token can be used for uploads without authentication header. Please provide the size of the intended upload so that the quota can be checked in advanced and no data is transferred unnecessarily. Notes are limited to **255** characters. ### Node naming convention: * Node (room, folder, file) names are limited to **150** characters. * Illegal names: `'CON', 'PRN', 'AUX', 'NUL', 'COM1', 'COM2', 'COM3', 'COM4', 'COM5', 'COM6', 'COM7', 'COM8', 'COM9', 'LPT1', 'LPT2', 'LPT3', 'LPT4', 'LPT5', 'LPT6', 'LPT7', 'LPT8', 'LPT9', (and any of those with an extension)` * Illegal characters in names: `'\\', '', ':', '\"', '|', '?', '*', '/', leading '-', trailing '.' `

Create new folder ### Description: Create a new folder. ### Precondition: User has 🔓 create permissions in current room. ### Postcondition: New folder is created. ### Further Information: Folders **CANNOT** be created on top level (without parent element). Notes are limited to **255** characters. ### Node naming convention: * Node (room, folder, file) names are limited to **150** characters. * Illegal names: `'CON', 'PRN', 'AUX', 'NUL', 'COM1', 'COM2', 'COM3', 'COM4', 'COM5', 'COM6', 'COM7', 'COM8', 'COM9', 'LPT1', 'LPT2', 'LPT3', 'LPT4', 'LPT5', 'LPT6', 'LPT7', 'LPT8', 'LPT9', (and any of those with an extension)` * Illegal characters in names: `'\\', '', ':', '\"', '|', '?', '*', '/', leading '-', trailing '.' `

Create new user group ### Description: Create a new user group. ### Precondition: Right 🔓 change groups required. ### Postcondition: A new user group is created. ### Further Information: * If a group should **NOT** expire, leave `expireAt` empty. * Group names are limited to **150** characters * Forbidden characters in group name: [``]

Create new Datev MST tax year ### Description: Create a Datev MST tax year. ### Precondition: Authenticated user. ### Postcondition: Datev MST tax year is created. ### 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 |

Create node comment ### Description: Create a comment for a specific node. ### Precondition: User has 🔓 read permissions on the node. ### Postcondition: Comment is created. ### Further Information: Maximum allowed text length: **65535** characters.

Create OAuth client ### Description: Create a new OAuth client. ### Precondition: Right 🔓 change global config and role 👤 Config Manager of the Provider Customer required. ### Postcondition: New OAuth client created. ### Further Information: Client secret **MUST** have: * at least 12 characters, at most 32 characters * only lower case characters, upper case characters and digits * at least 1 lower case character, 1 upper case character and 1 digit The client secret is optional and will be generated for confidential clients if it is left empty. Valid grant types are: * `authorization_code` * `implicit` * `password` * `client_credentials` * `refresh_token` Grant type `client_credentials` is currently **NOT** permitted! Allowed characters for client ID are: `[a-zA-Z0-9_-]` If grant types `authorization_code` or `implicit` are used, a redirect URI **MUST** be provided! Default access token validity: **8 hours** Default refresh token validity: **30 days** Default approval validity: **½ year**

Create OpenID Connect IDP configuration ### Description: Create new OpenID Connect IDP configuration. ### Precondition: Right 🔓 change global config and role 👤 Config Manager of the Provider Customer required. ### Postcondition: New OpenID Connect IDP configuration is created. ### Further Information: None.

Create new room ### Description: Creates a new room at the provided parent node. Creation of top level rooms provided. ### Precondition: User has 🔓 manage permissions in the parent room. ### Postcondition: A new room is created. ### Further Information: Rooms may only have other rooms as parent. Rooms on top level do **NOT** have any parent. Rooms may have rooms as children on n hierarchy levels. If permission inheritance is disabled, there **MUST** be at least one admin user / group (with neither the group nor the user having an expiration date). Notes are limited to **255** characters. Provided (or default) classification is taken from room when file gets uploaded without any classification. ### Node naming convention: * Node (room, folder, file) names are limited to **150** characters. * Illegal names: `'CON', 'PRN', 'AUX', 'NUL', 'COM1', 'COM2', 'COM3', 'COM4', 'COM5', 'COM6', 'COM7', 'COM8', 'COM9', 'LPT1', 'LPT2', 'LPT3', 'LPT4', 'LPT5', 'LPT6', 'LPT7', 'LPT8', 'LPT9', (and any of those with an extension)` * Illegal characters in names: `'\\', '', ':', '\"', '|', '?', '*', '/', leading '-', trailing '.' `

Create S3 storage configuration ### Description: Create new S3 configuration. ### Precondition: Right 🔓 change global config and role 👤 Config Manager of the Provider Customer required. ### Postcondition: New S3 configuration is created. ### Further Information: Forbidden characters in bucket names: [`.`] `bucketName` and `endpointUrl` are deprecated, use `bucketUrl` instead. ### Virtual hosted style access Example: https://bucket-name.s3.region.amazonaws.com/key-name

Create S3 tag ### Description: Create new S3 tag. ### Precondition: Right 🔓 change global config and role 👤 Config Manager of the Provider Customer required. ### Postcondition: New S3 tag is created. ### Further Information: * Maximum key length: **128** characters. * Maximum value length: **256** characters. * Both S3 tag key and value are **case-sensitive** strings. * Maximum of **20 mandatory S3 tags** is allowed.

Create new file upload channel ### Description: Create a new upload channel. ### Precondition: None. ### Postcondition: Upload channel is created and corresponding upload URL, token & upload ID are returned. ### Further Information: Use `uploadUrl` the upload `token` is deprecated. Please provide the size of the intended upload so that the quota can be checked in advanced and no data is transferred unnecessarily. ### Node naming convention: * Node (room, folder, file) names are limited to **150** characters. * Illegal names: `'CON', 'PRN', 'AUX', 'NUL', 'COM1', 'COM2', 'COM3', 'COM4', 'COM5', 'COM6', 'COM7', 'COM8', 'COM9', 'LPT1', 'LPT2', 'LPT3', 'LPT4', 'LPT5', 'LPT6', 'LPT7', 'LPT8', 'LPT9', (and any of those with an extension)` * Illegal characters in names: `'\\', '', ':', '\"', '|', '?', '*', '/', leading '-', trailing '.' `

Create tenant webhook ### Description: Create a new webhook for the tenant scope. ### Precondition: Right 🔓 manage webhook required. ### Postcondition: Webhook is created for given event types. ### Further Information: URL must begin with the `HTTPS` scheme. Webhook names are limited to 150 characters. ### Available event types: Expand | Name | Description | Scope | | :--- | :--- | :--- | | **`customer.created`** | Triggered when a new customer is created | Tenant Webhook | | **`customer.deleted`** | Triggered when a user is deleted | Tenant Webhook | | **`webhook.expiring`** | Triggered 30/20/10/1 days before a webhook expires | Tenant Webhook |

Create new Upload Share ### Description: Create a new Upload Share (aka File Request). ### Precondition: User has 🔓 manage upload share permissions on target container. ### Postcondition: Upload Share is created. ### Further Information: * `name` is limited to **150** characters. * `notes` are limited to **255** characters. * `password` is limited to **72** characters. Forbidden characters in passwords: [`&`, `'`, ``]. Forbidden characters in share names: [``]. Use `POST /shares/uploads/{share_id}/email` API for sending emails. Please keep in mind that due to various restrictions of different telecommunication providers, non-ASCII characters may not be displayed correctly in short messages (SMS).

Create new user ### Description: Create a new user. ### Precondition: Right 🔓 change users required. ### Postcondition: New user is created. ### Further Information: * If a user should **NOT** expire, leave `expireAt` empty. * All input fields are limited to **150** characters * Forbidden characters in first name, last name and username: [``] * Forbidden characters in passwords: [`&`, `'`, ``] ### Authentication Method Options: Expand | Authentication Method | Option Key | Option Value | |:----------------------|:------------------------------|:---------------------------------------------------------------------------| | `basic` / `sql` | `username` | Unique user identifier | | `active_directory` | `ad_config_id` (optional) | Active Directory configuration ID | | | `username` | Active Directory username according to authentication setting `userFilter` | | `openid` | `openid_config_id` (optional) | OpenID Connect configuration ID | | | `username` | OpenID Connect username according to authentication setting `mappingClaim` |

Create webhook ### Description: Create a new webhook for the customer scope. ### Precondition: Right 🔓 change config required. ### Postcondition: Webhook is created for given event types. ### Further Information: URL must begin with the `HTTPS` scheme. Webhook names are limited to 150 characters. ### Available event types: Expand | Name | Description | Scope | | :--- | :--- | :--- | | **`user.created`** | Triggered when a new user is created | Customer Admin Webhook | | **`user.deleted`** | Triggered when a user is deleted | Customer Admin Webhook | | **`user.locked`** | Triggered when a user gets locked | Customer Admin Webhook | | | | | | **`webhook.expiring`** | Triggered 30/20/10/1 days before a webhook expires | Customer Admin Webhook | | | | | | **`downloadshare.created`** | Triggered when a new download share is created in affected room | Node Webhook | | **`downloadshare.deleted`** | Triggered when a download share is deleted in affected room | Node Webhook | | **`downloadshare.used`** | Triggered when a download share is utilized in affected room | Node Webhook | | **`uploadshare.created`** | Triggered when a new upload share is created in affected room | Node Webhook | | **`uploadshare.deleted`** | Triggered when a upload share is deleted in affected room | Node Webhook | | **`uploadshare.used`** | Triggered when a new file is uploaded via the upload share in affected room | Node Webhook | | **`file.created`** | Triggered when a new file is uploaded in affected room | Node Webhook | | **`folder.created`** | Triggered when a new folder is created in affected room | Node Webhook | | **`room.created`** | Triggered when a new room is created (in affected room) | Node Webhook | | **`file.deleted`** | Triggered when a file is deleted in affected room | Node Webhook | | **`folder.deleted`** | Triggered when a folder is deleted in affected room | Node Webhook | | **`room.deleted`** | Triggered when a room is deleted in affected room | Node Webhook |

Remove Download Shares ### Functional Description: Delete multiple Download Shares. ### Precondition: User with _"manage download share"_ permissions on target nodes. ### Postcondition: Download Shares are deleted. ### Further Information: Only the Download Shares are removed; the referenced files or containers persists.

Disable a MFA TOTP setup with generated OTP ### Description: Delete multi-factor authentication TOTP setup with a valid OTP code. ### Precondition: Authenticated user Multi-factor authentication is **NOT** enforced ### Postcondition: Second factor TOTP is disabled. ### Further Information: None.