InstanceSetting_GeneralSetting

Where this schema is used

These links are derived from direct references in the protocol snapshot. Follow the calling operation for authentication, accepted fields and runtime behavior; a reusable resource schema is not by itself a complete write request.

Referenced by these component schemas:

• InstanceSetting

Shape and fields

object

General instance settings configuration.

Complete schema

Use this complete JSON definition for constraints and nested structure. A field's presence here does not mean it is writable by every caller.

{
  "type": "object",
  "properties": {
    "disallowUserRegistration": {
      "type": "boolean",
      "description": "disallow_user_registration disallows user registration."
    },
    "disallowPasswordAuth": {
      "type": "boolean",
      "description": "disallow_password_auth disallows password authentication."
    },
    "additionalScript": {
      "type": "string",
      "description": "additional_script is the additional script."
    },
    "additionalStyle": {
      "type": "string",
      "description": "additional_style is the additional style."
    },
    "customProfile": {
      "allOf": [
        {
          "$ref": "#/components/schemas/GeneralSetting_CustomProfile"
        }
      ],
      "description": "custom_profile is the custom profile."
    },
    "weekStartDayOffset": {
      "type": "integer",
      "description": "week_start_day_offset is the week start day offset from Sunday.\n 0: Sunday, 1: Monday, 2: Tuesday, 3: Wednesday, 4: Thursday, 5: Friday, 6: Saturday\n Default is Sunday.",
      "format": "int32"
    },
    "disallowChangeUsername": {
      "type": "boolean",
      "description": "disallow_change_username disallows changing username."
    },
    "disallowChangeNickname": {
      "type": "boolean",
      "description": "disallow_change_nickname disallows changing nickname."
    }
  },
  "description": "General instance settings configuration."
}