action dracoon_update_system_settings {
label: "Update system settings"
description: "
🚧 Deprecated since v4.6.0
\n\n### Description:\nUpdate configurable settings.\n\n### Precondition:\nRight 🔓 change global config and\nrole 👤 Config Manager of the Provider Customer required.\n\n### Postcondition:\nOne or more global settings gets changed.\n\n### Further Information:\nThis API is deprecated and will be removed in the future. \nCheck for every settings key new corresponding API and key below.\n\n### Configurable settings:\n\nExpand
\n\n| Setting | Description | Value |\n| :--- | :--- | :--- |\n| `branding_server_branding_id` | The branding UUID, which corresponds to _BRANDING-QUALIFIER_ in the new branding server.
cf. `PUT /system/config/settings/branding` `BrandingConfig.brandingQualifier` | `String` |\n| `branding_portal_url` | Access URL to to the Branding Portal
Only visible for _Config Manager_ of Provider Customer.
cf. `PUT /system/config/settings/branding` `BrandingConfig.brandingProviderUrl` | `String` |\n| `dblog` | Write logs to local database.
Only visible for _Config Manager_ of Provider Customer.
cf. `PUT /system/config/settings/eventlog` `EventlogConfig.enabled` | `true or false` |\n| `default_downloadshare_expiration_period` | Default expiration period for Download Shares in days
cf. `PUT /system/config/settings/defaults` `SystemDefaults.downloadShareDefaultExpirationPeriod` | `Integer between 0 and 9999`
Set `0` to disable. |\n| `default_file_upload_expiration_date` | Default expiration period for all uploaded files in days
cf. `PUT /system/config/settings/defaults` `SystemDefaults.fileDefaultExpirationPeriod` | `Integer between 0 and 9999`
Set `0` to disable. |\n| `default_language` | Define which language should be default.
cf. `PUT /system/config/settings/defaults` `SystemDefaults.languageDefault` | cf. `GET /public/system/info` - `SystemInfo.languageDefault` |\n| `default_uploadshare_expiration_period` | Default expiration period for Upload Shares in days
cf. `PUT /system/config/settings/defaults` `SystemDefaults.uploadShareDefaultExpirationPeriod` | `Integer between 0 and 9999`
Set `0` to disable. |\n| `enable_client_side_crypto` | Activation status of client-side encryption
Can only be enabled once; disabling is **NOT** possible.
cf. `PUT /system/config/settings/general` `GeneralSettings.cryptoEnabled` | `true or false`
default: `false` |\n| `eula_active` | Each user has to confirm the EULA at first login.
cf. `PUT /system/config/settings/general` `GeneralSettings.eulaEnabled` | `true or false` |\n| `eventlog_retention_period` | Retention period (in days) of event log entries
After that period, all entries are deleted.
cf. `PUT /system/config/settings/eventlog` `EventlogConfig.retentionPeriod` | `Integer between 0 and 9999`
If set to `0`: no logs are deleted
Recommended value: `7` |\n| `ip_address_logging` | Determines whether a user's IP address is logged.
Only visible for _Config Manager_ of Provider Customer.
cf. `PUT /system/config/settings/eventlog` `EventlogConfig.logIpEnabled`
cf. `PUT /system/config/settings/syslog` `SyslogConfig.logIpEnabled` | `true or false` |\n| `mailserver` | Email server to send emails.
Only visible for _Config Manager_ of Provider Customer.
cf. `PUT /system/config/settings/mail_server` `MailServerConfig.host` | `DNS name or IPv4 of an email server` |\n| `mailserver_authentication_necessary` | Set to `true` if the email server requires authentication.
Only visible for _Config Manager_ of Provider Customer.
cf. `PUT /system/config/settings/mail_server` `MailServerConfig.authenticationEnabled` | `true or false` |\n| `mailserver_password` | Password for email server
cf. `PUT /system/config/settings/mail_server` `MailServerConfig.password` | `Password for authentication` |\n| `mailserver_port` | Email server port
Only visible for _Config Manager_ of Provider Customer.
cf. `PUT /system/config/settings/mail_server` `MailServerConfig.port` | `Valid port number` |\n| `mailserver_username` | Username for email server
Only visible for _Config Manager_ of Provider Customer.
cf. `PUT /system/config/settings/mail_server` `MailServerConfig.username` | `Username for authentication` |\n| `mailserver_use_ssl` | Email server requires SSL connection?
Only visible for _Config Manager_ of Provider Customer.
Requires `mailserver_use_starttls` to be `false`
cf. `PUT /system/config/settings/mail_server` `MailServerConfig.username` | `true or false` |\n| `mailserver_use_starttls` | Email server requires StartTLS connection?
Only visible for _Config Manager_ of Provider Customer.
Requires `mailserver_use_ssl` to be `false`
cf. `PUT /system/config/settings/mail_server` `MailServerConfig.starttlsEnabled` | `true or false` |\n| `syslog` | Write logs to a syslog interface.
Only visible for _Config Manager_ of Provider Customer.
cf. `PUT /system/config/settings/syslog` `SyslogConfig.enabled` | `true or false` |\n| `syslog_host` | Syslog server (IP or FQDN)
Only visible for _Config Manager_ of Provider Customer.
cf. `PUT /system/config/settings/syslog` `SyslogConfig.host` | `DNS name or IPv4 of a syslog server` |\n| `syslog_port` | Syslog server port
Only visible for _Config Manager_ of Provider Customer.
cf. `PUT /system/config/settings/syslog` `SyslogConfig.port` | `Valid port number` |\n| `syslog_protocol` | Protocol to connect to syslog server.
Only visible for _Config Manager_ of Provider Customer.
cf. `PUT /system/config/settings/syslog` `SyslogConfig.protocol` | `TCP or UDP` |\n| `enable_email_notification_button` | Enable mail notification button.
cf. `PUT /system/config/settings/general` `GeneralSettings.emailNotificationButtonEnabled` | `true or false` |\n| `allow_share_password_sms` | Allow sending of share passwords via SMS.
cf. `PUT /system/config/settings/general` `GeneralSettings.sharePasswordSmsEnabled` | `true or false` |\n\n \n\n### Deprecated settings:\n\nExpand
\n\n| Setting | Description | Value |\n| :--- | :--- | :--- |\n| `allow_system_global_weak_password` | Determines whether weak password (cf. _Password Policy_ below) is allowed.
cf. `PUT /system/config/settings/general` `GeneralSettings.weakPasswordEnabled`
Use `PUT /system/config/policies/passwords` API to change configured password policies. | `true or false` |\n| `branding_server_customer` | The UUID of the branding server customer, which corresponds to customer key in the branding server. | `String` |\n| `branding_server_url` | Access URL to to the Branding Server.
Only visible for _Config Manager_ of Provider Customer. | `String` |\n| `email_from` | Sender of system-generated emails
Only visible for _Config Manager_ of Provider Customer.
**Moved to branding** | `Valid email address` |\n| `email_to_sales` | Contact email address for customers to request more user licenses or data volume.
**Moved to branding** | `Valid email address` |\n| `email_to_support` | Support email address for users
**Moved to branding** | `Valid email address` |\n| `file_size_js` | Maximum file size (in bytes) for downloads of encrypted files with JavaScript.
Bigger files will require a JavaApplet. | `Integer`
Recommended value: `10485760` (=`10MB`) |\n| `system_name` | System name
**Moved to branding** use `product.title` | `Display name of the DRACOON` |\n\n "
provider: dracoon
method: PUT
path: "/v4/config/settings"
encoding: json
input: {
type: "object"
properties: {
"X-Sds-Auth-Token": {
type: "string"
}
items: {
type: "array"
description: "List of key-value pairs"
items: {
type: "object"
description: "Key-value pair"
required: ["key", "value"]
properties: {
key: {
type: "string"
description: "Entry key"
}
value: {
type: "string"
description: "Entry value"
}
}
}
}
}
required: ["items"]
additionalProperties: false
}
output: {
type: "object"
additionalProperties: true
}
}