Request general settings

v1.0.0

🚀 Since v4.6.0

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`

Input

{
  "type": "object",
  "properties": {
    "X-Sds-Auth-Token": {
      "type": "string"
    }
  },
  "additionalProperties": false
}

Output

{
  "type": "object",
  "description": "General settings",
  "properties": {
    "authTokenRestrictions": {
      "type": "object",
      "description": "Auth token restrictions",
      "properties": {
        "accessTokenValidity": {
          "type": "integer",
          "format": "int32",
          "description": "&#128640; Since v4.13.0\n\nRestricted OAuth access token validity (in seconds)"
        },
        "refreshTokenValidity": {
          "type": "integer",
          "format": "int32",
          "description": "&#128640; Since v4.13.0\n\nRestricted OAuth refresh token validity (in seconds)"
        },
        "restrictionEnabled": {
          "type": "boolean",
          "description": "&#128640; Since v4.13.0\n\nDefines if OAuth token restrictions are enabled"
        }
      }
    },
    "cryptoEnabled": {
      "type": "boolean",
      "description": "Activation status of client-side encryption.\n\nCan only be enabled once; disabling is not possible."
    },
    "emailNotificationButtonEnabled": {
      "type": "boolean",
      "description": "Enable email notification button"
    },
    "eulaEnabled": {
      "type": "boolean",
      "description": "Each user has to confirm the EULA at first login."
    },
    "hideLoginInputFields": {
      "type": "boolean",
      "description": "&#128679; Deprecated since v4.42.0\n\nDefines if login fields should be hidden"
    },
    "mediaServerEnabled": {
      "type": "boolean",
      "description": "&#128679; Deprecated since v4.12.0\n\nDetermines if the media server is enabled"
    },
    "s3TagsEnabled": {
      "type": "boolean",
      "description": "&#128640; Since v4.9.0\n\nDefines if S3 tags are enabled"
    },
    "sharePasswordSmsEnabled": {
      "type": "boolean",
      "description": "Allow sending of share passwords via SMS"
    },
    "useS3Storage": {
      "type": "boolean",
      "description": "Defines if S3 is used as storage backend"
    },
    "weakPasswordEnabled": {
      "type": "boolean",
      "description": "&#128679; Deprecated since v4.14.0\n\nAllow weak password\n\n* A weak password has to fulfill the following criteria:\n\n   * is at least 8 characters long\n\n   * contains letters and numbers\n\n* A strong password has to fulfill the following criteria in addition:\n\n   * contains at least one special character\n\n   * contains upper and lower case characters\n\nPlease use `GET /system/config/policies/passwords` API to get configured password policies."
    }
  }
}