Request general settings

v1.0.0

🚀 Since v4.6.0

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`

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`

Input

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

Output

{
  "type": "object",
  "description": "General settings",
  "required": [
    "homeRoomsActive",
    "subscriptionPlan"
  ],
  "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"
    },
    "homeRoomParentId": {
      "type": "integer",
      "format": "int64",
      "description": "&#128640; Since v4.10.0\n\nHomeroom Parent ID"
    },
    "homeRoomsActive": {
      "type": "boolean",
      "description": "&#128640; Since v4.10.0\n\nHomerooms active"
    },
    "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"
    },
    "subscriptionPlan": {
      "type": "integer",
      "format": "int32",
      "description": "&#128640; Since v4.30.0\n\nSubscription Plan"
    },
    "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."
    }
  }
}