Get General Settings V5
All the listed privileges are required -
| Privileges | Description |
|---|---|
| GLOBAL_CONFIG_VIEW | Caller should have permission to this privilege, to read settings. |
OK
{
"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,
"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
}Determines how long (in minutes) a refresh token is valid for and an idle View API session continues before the session times out. Setting the API session timeout to a high number of minutes increases the risk of unauthorized use of View API. Use caution when you allow an idle session to persist for a long time.
The time allowed to elapse after a user has authenticated before the application SSO credentials are locked unless the user's Horizon client supports idle sessions and the user remains active.
Specifies the policy for the maximum time after which single sign on will be disabled for application sessions.
- DISABLED_AFTER: Single sign on will be disabled after the specified number of minutes has elapsed since the user connected to Horizon Connection Server.
- DISABLED: Single sign on is disabled.
- ENABLED: Single sign on is enabled.
Indicates whether Horizon Client Connections are to be blocked if client is not part of restricted_client_data.
Determines how long a user can be idle before the Connection Server takes measure to protect the session.
Specifies the policy for the maximum time that a that a user can be idle before the Connection Server takes measure to protect the session.
- TIMEOUT_AFTER: The timeout is set for a configurable time.
- NEVER: The timeout has been disabled.
Determines how long a user can keep a session open after logging in to the Connection Server. When a session times out, the session is terminated and the Horizon client is disconnected from the resource. This property has a default value of 600 and a minimum value of 5. This property is required if clientMaxSessionTimeoutPolicy is set to TIMEOUT_AFTER.
Client max session lifetime policy. This property has a default value of TIMEOUT_AFTER. A value of TIMEOUT_AFTER indicates that the Horizon client session times out after a configurable session length. A value of NEVER indicates that the Horizon client session will not time out and will only end due to inactivity.
- TIMEOUT_AFTER: The timeout is set for a configurable time.
- NEVER: The timeout has been disabled.
Determines the maximum length of time that a session will be kept active if there is no traffic between the Horizon client and the Connection Server.
Determines how long an idle admin console session continues before the session times out.
The message to be displayed at the time of forced disconnect.
The warning to be displayed before forcibly disconnect timeout.
The time (in minutes) prior to the forcibly disconnect timeout when a warning message would be shown by the client
Enable/disable pre login message pop up before logging into Horizon admin console
Indicates whether to show a disclaimer or other message when the Horizon Client user logs in. This change will take effect on next login for each user.
Indicates whether to display a warning message when users are forced to log off because a scheduled or immediate update such as a machine-refresh operation is about to start.
Enable updation of the global status of the application periodically. The Dashboard Information is also updated at regular intervals when Dashboard page is active.
Indicates whether to clean up session credentials when one tab connecting to remote machine/application is closed.
Enables 2 factor re-authentication after idle session timeout.
Indicates whether the domain list will be sent to the Horizon client. Since domain list will be sent before user is authenticated with server, it could disclose domain information to external users.
Permits RDSServer operating systems to be used for non-RDS Machines.
The warning to be displayed before logging off the user.
The time to wait after the warning is displayed and before logging off the user.
Whether to hide the list of domains in the Horizon client user interface. If value set to true, the user will need to provide a UPN (e.g. user@domain) or a logon name in the format domain\user when logging in.
Indicates whether to hide the server URL in the Horizon client user interface.
Single sign on will be disabled after the specified time has elapsed since the user connected to Connection Server.
Specifies the policy for the maximum time after which single sign on will be disabled after a user connects to the Connection Server.
- DISABLED_AFTER: Single sign on will be disabled after the specified number of minutes has elapsed since the user connected to Horizon Connection Server.
- DISABLED: Single sign on is disabled.
- ENABLED: Single sign on is enabled.
The Error message that needs to be displayed at the client for end users incase resetting password fails because of policy violations
The warning pop up header to be displayed before logging into Horizon admin console, if pre login message pop up is activated for the same.
The warning pop up message to be displayed before logging into Horizon admin console, if pre login message pop up is activated for the same.
Displays a disclaimer or another message to Horizon Client users when they log in. No message will be displayed if this is not set.
List of restricted Horizon Clients.
The message to be displayed to Horizon clients which are blocked by the Connection Server.
The message to be displayed to Horizon clients which are not recommended by the Connection Server.
The type of connection for which the single sign on discard timeout minutes should be applied.
- NONE: Indicates the connections from client devices on neither private networks nor non-private networks.
- INTERNAL: Indicates the connections from client devices on private networks.
- EXTERNAL: Indicates the connections from client devices on non-private networks.
- BOTH: Indicates the connections from client devices both on private and non-private networks.
Determines whether or not to store the RDS Per Device Client Access License on Horizon client devices. This value can be true only if Store Client Access License on Connection Server is true.
Determines whether or not to store the RDS Per Device Client Access License on Connection Server.
User is not authenticated
Access to the resource is forbidden