SettingsUpdateSpecV5

SettingsUpdateSpecV5
SettingsUpdateSpecV5

Configuration settings object to be updated.

JSON Example
{
    "agent_restriction_settings": {
        "restricted_agent_data": [
            {
                "block_specific_versions": [
                    "7.6,0",
                    "8.0.0"
                ],
                "type": "WINDOWS",
                "version": "7.5.0"
            }
        ],
        "restricted_agent_message": "The system does not support this version of the Horizon Agent."
    },
    "client_settings": {
        "client_policies": [
            {
                "enforcement_state": "REQUIRED",
                "policy": "CERTIFICATE_VALIDATION",
                "policy_values": [
                    "ENFORCE"
                ]
            }
        ]
    },
    "feature_settings": {
        "cloud_managed": true
    },
    "general_settings": {
        "api_session_timeout_minutes": 30,
        "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,
        "disconnect_message": "string",
        "disconnect_warning_message": "string",
        "disconnect_warning_time": 30,
        "display_pre_login_admin_banner": false,
        "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,
        "enable_user_name_caching": 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",
        "password_policy_error_message": "The new password does not meet the password policy requirements.",
        "pre_login_admin_banner_header": "Attention",
        "pre_login_admin_banner_message": "On proceeding, you agree that you fully comply with the laws of this organisation.",
        "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.",
        "sso_discard_connection_type": "BOTH",
        "store_cal_on_client": false,
        "store_cal_on_connection_server": false
    },
    "security_settings": {
        "cert_auth_mapping": [
            "x509:<I>%issuer_dn%<S>%subject_dn%<SKI>%subject_key_id%",
            "x509:<I>%issuer_dn%<SR>%serial%"
        ],
        "cert_auth_mapping_control": [
            "CUSTOM",
            "SID"
        ],
        "crl_distribution_points": [
            "http://www.cdpexample.com/file.crl",
            "http://crls.pki.goog/gts1c3/file1.pem"
        ],
        "crl_file_max_size_kb": 1024,
        "crl_refresh_period_minutes": 100,
        "data_recovery_password_hash": [
            "5e884898da28047151d0e56f8dc6292773603d0d6aabbdd62a11ef721d1542d8"
        ],
        "data_recovery_password_hint": "password hint",
        "message_security_mode": "ENABLED",
        "re_auth_secure_tunnel_after_interruption": true
    }
}
agent_restriction_settings
Optional

agent_restriction_settings

client_settings
Optional

client_settings

feature_settings
Optional

feature_settings

general_settings
Optional

general_settings

security_settings
Optional

security_settings