Update Settings V2 | VMware Horizon Server API

Update Settings V2

All the listed privileges are required -

Privileges	Description
GLOBAL_CONFIG_MANAGEMENT	Caller should have permission to this privilege, to update settings.

Request

URI

PUT

https://{api_host}//localhost/rest/config/v2/settings

COPY

Request Body

Configuration settings object to be updated.

SettingsUpdateSpecV2 of type(s) application/json

Required

{
    "feature_settings": {
        "cloud_managed": true
    },
    "general_settings": {
        "application_sso_timeout_minutes": 30,
        "application_sso_timeout_policy": "ENABLED",
        "block_restricted_clients": false,
        "client_idle_session_timeout_minutes": 300,
        "client_idle_session_timeout_policy": "NEVER",
        "client_max_session_timeout_minutes": 300,
        "client_max_session_timeout_policy": "TIMEOUT_AFTER",
        "client_session_timeout_minutes": 300,
        "console_session_timeout_minutes": 30,
        "display_pre_login_message": false,
        "display_warning_before_forced_logoff": true,
        "enable_automatic_status_updates": true,
        "enable_credential_cleanup_for_htmlaccess": false,
        "enable_multi_factor_re_authentication": false,
        "enable_sending_domain_list": false,
        "enable_server_in_single_user_mode": true,
        "forced_logoff_message": "The system will shut down shortly. Please save your work.",
        "forced_logoff_timeout_minutes": 3,
        "hide_domain_list_in_client": true,
        "hide_server_information_in_client": false,
        "machine_sso_timeout_minutes": 300,
        "machine_sso_timeout_policy": "DISABLED_AFTER",
        "pre_login_message": "Disclaimer : This server is being monitored for suspicious activity.",
        "restricted_client_data_v2": [
            {
                "block_specific_versions": [
                    "3.5,4",
                    "4.0.1"
                ],
                "type": "WINDOWS",
                "version": 7.5,
                "warn_specific_versions": [
                    "7.5,4",
                    "5.0.2"
                ]
            }
        ],
        "restricted_client_message": "The system does not support this version of the Horizon client.",
        "restricted_client_warn_message": "This client version is not recommended. Please upgrade to the latest version.",
        "store_cal_on_client": false,
        "store_cal_on_connection_server": false
    },
    "security_settings": {
        "data_recovery_password_hash": [
            "string"
        ],
        "data_recovery_password_hint": "password hint",
        "message_security_mode": "ENABLED",
        "re_auth_secure_tunnel_after_interruption": true
    }
}

FeatureSettingsUpdateSpec

feature_settings

Optional

feature_settings

GeneralSettingsUpdateSpecV2

general_settings

Optional

general_settings

SecuritySettingsUpdateSpec

security_settings

Optional

security_settings