Clients

Get

Retrieve the client settings

GET/api/ClientSettings

Query parameters

Response

200401404

Success

Body

application/json; api-version=1.0

excludeDirectRDPnullable string

Exclude Direct RDP Connections for terminal servers.

excludeDirectRDPForVDInullable string

Exclude Direct RDP Connections for VDI.

sendHDIconsboolean

Enable or disable Sending HD Icons.

replicateSendHDIconsboolean

Enable replicate Sending HD Icons.

enableOverlayIconsboolean

Enable or disable Overlay Icons (deprecated).

overlayIconOverlayIconType (enum)

Overlay Icon Type.

0 = None,1 = ParallelsRemoteApplication,2 = MicrosoftRemoteApp,3 = Custom

showPasswordExpiryboolean

Show or hide Password Expiry reminder.

forceSessionsResetboolean

Enable or disable Force sessions reset when client performs a logoff.

tokenValidationExpireMininteger (int32)

Token Validation Time. The time for a validation token to expire in minutes.

Request

JavaScriptCurlPython

const response = await fetch('/api/ClientSettings', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200401404

{
  "excludeDirectRDP": "text",
  "excludeDirectRDPForVDI": "text",
  "sendHDIcons": false,
  "replicateSendHDIcons": false,
  "enableOverlayIcons": false,
  "overlayIcon": [
    "0 = None",
    "1 = ParallelsRemoteApplication",
    "2 = MicrosoftRemoteApp",
    "3 = Custom"
  ],
  "showPasswordExpiry": false,
  "forceSessionsReset": false,
  "tokenValidationExpireMin": 0
}

Update

Modify Client Settings. For each setting, the request has a corresponding parameter. To modify a setting, specify a matching parameter and its value.

PUT/api/ClientSettings

Query parameters

Body

application/json; api-version=1.0

Client Settings

apLockboolean

siteIdinteger (int32)

The site ID. To obtain the ID of a desired site, use the Get-Sites cmdlet.

excludeDirectRDPnullable string

Exclude Direct RDP Connections for terminal servers.

excludeDirectRDPForVDInullable string

Exclude Direct RDP Connections for VDI.

sendHDIconsnullable boolean

Enable or disable Sending HD Icons.

replicateSendHDIconsnullable boolean

Enable or disable replicate Sending HD Icons.

overlayIconOverlayIconType (enum)

Overlay Icon Type.

0 = None,1 = ParallelsRemoteApplication,2 = MicrosoftRemoteApp,3 = Custom

showPasswordExpirynullable boolean

Show or hide Password Expiry reminder.

forceSessionsResetnullable boolean

Enable or disable Force sessions reset when client performs a logoff.

tokenValidationExpireMinnullable integer (int32)

Token Validation Time. The time for a validation token to expire in minutes.

Response

204401404

No Content

Request

JavaScriptCurlPython

const response = await fetch('/api/ClientSettings', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json; api-version=1.0"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

401404

{
  "type": "text",
  "title": "text",
  "status": 0,
  "detail": "text",
  "instance": "text"
}