Policies

List

get

Retrieve client policy/ies.

Query parameters
namestringOptional

Client policy name (optional)

Responses
chevron-right
200

OK

application/json; api-version=1.0
get
/api/ClientPolicies

Create

post

Add a new client policy.

Body

Create a new client policy

namestring · min: 1 · max: 255 · nullableRequired

Name of the new client policy.

enabledboolean · nullableOptional

Whether the new client policy will be enabled or disabled.

descriptionstring · nullableOptional

Description for the new client policy.

Responses
post
/api/ClientPolicies

Get

get

Retrieve a specific client policy by ID.

Path parameters
idinteger · int32Required

Client Policy ID

Responses
chevron-right
200

OK

application/json; api-version=1.0
get
/api/ClientPolicies/{id}

Update

put

Update settings of a client policy. For each setting, the request has a corresponding parameter. To modify a setting, specify a matching parameter and its value.

Path parameters
idinteger · int32Required

Client policy ID

Body

Update a RAS Client Policy

namestring · min: 1 · max: 255 · nullableOptional

The new name of the specified client policy.

enabledboolean · nullableOptional

Enable or disable the specified client policy.

descriptionstring · nullableOptional

A user-defined description for the client policy.

orderinteger · int32 · nullableOptional

The order of the client policy.

primaryConnectionEnabledboolean · nullableOptional

Primary Connection: Whether Primary Connection is enabled or not.

connectionNamestring · min: 1 · max: 255 · nullableOptional

Primary Connection: The name of the primary connection.

autoLoginboolean · nullableOptional

Primary Connection: Allow the user to auto login.

authenticationTypestring · enumOptional

Authentication Type.

Possible values:
savePasswordboolean · nullableOptional

Primary Connection: Password will be saved when user successfully logs in.

domainstring · min: 1 · max: 255 · nullableOptional

Primary Connection: The name of the domain.

secondaryConnectionsEnabledboolean · nullableOptional

Secondary Connection: If Secondary Connection is enabled or not.

reconnectIfDroppedboolean · nullableOptional

Reconnection: If Reconnection Flag is enabled or not.

reconnectionEnabledboolean · nullableOptional

Reconnection: When the connection drops allows for automatic reconnection.

connectionRetriesinteger · int32 · nullableOptional

Reconnection: The amount of connection retries.

reconnectionConnectionBannerDelayinteger · int32 · nullableOptional

Reconnection: If connection is not established after an amount of seconds given, the banner will show.

computerNameEnabledboolean · nullableOptional

Computer Name: Whether Computer Name is enabled or not.

overrideComputerNamestring · min: 1 · max: 255 · nullableOptional

Computer Name: The computer name which can be overridden.

connectionAdvancedSettEnabledboolean · nullableOptional

Connection Advanced Settings: Whether Connection Advanced Settings is enabled or not.

connectionTimeoutinteger · int32 · nullableOptional

Connection Advanced Settings: The total number of seconds where the connection will timeout.

connectionAdvancedSettConnectionBannerDelayinteger · int32 · nullableOptional

Connection Advanced Settings: If connection is not established after an amount of seconds given, the banner will show.

showDesktopTimeoutinteger · int32 · nullableOptional

Connection Advanced Settings: If published application does not start after several seconds this will show.

webAuthenticationEnabledboolean · nullableOptional

Web Authentication: Whether the web authentication is enabled or not.

defaultOsBrowserboolean · nullableOptional

Web Authentication: If the box is checked the os will use the default browser.

openBrowserOnLogoutboolean · nullableOptional

Web Authentication: Whether the browser is shown when logging out of web authentication with the internal browser.

multiFactorAuthenticationEnabledboolean · nullableOptional

Multi Factor Authentication: Whether Multi factor authentication is enabled or not.

rememberLastUsedMethodboolean · nullableOptional

Multi Factor Authentication: Will remember the last used method.

sessionPreLaunchEnabledboolean · nullableOptional

Session Prelaunch: Whether Session PreLaunch was enabled or not.

preLaunchModestring · enumOptional

Session Mode Type.

Possible values:
localProxyAddressEnabledboolean · nullableOptional

Local Proxy Address: Whether Local Proxy Address is enabled or not.

useLocalHostProxyIPboolean · nullableOptional

Local Proxy Address: Whether the 127.0.0.1 IP address is used when using Gateway mode in VPN scenarios or not.

preLaunchExcludestring[] · nullableOptional

Session Prelaunch: The list of the session prelaunch.

browserEnabledboolean · nullableOptional

Browser: Whether Display Settings Browser is enabled or not.

browserOpenInstring · enumOptional

Open Applications In Type.

Possible values:
desktopOptionsEnabledboolean · nullableOptional

Desktop Options: Whether Display Settings Options is enabled or not.

smartSizingstring · enumOptional

Smart Sizing Type.

Possible values:
embedDesktopboolean · nullableOptional

Desktop Options: If box is checked the desktop will always be fixed.

spanDesktopsboolean · nullableOptional

Desktop Options: If box is checked the desktop will spanned across all other monitors.

fullScreenBarstring · enumOptional

Connection Bar Type.

Possible values:
multiMonitorEnabledboolean · nullableOptional

Multi Monitor: Whether Display Settings is enabled or not.

displayConfigstring · enumOptional

Display configuration Type.

Possible values:
publishedApplicationsEnabledboolean · nullableOptional
usePrimaryMonitorboolean · nullableOptional

Published Applications: Use the primary monitor only.

useDynamicDesktopResizingboolean · nullableOptional

Published Applications: Use dynamic desktop resizing.

useAvailAreaForAppSingleMonitorboolean · nullableOptional

Published Applications: Use available area for an application on a single monitor (User Portal).

settingsEnabledboolean · nullableOptional

Settings: Whether Display Settings is enabled or not.

colorDepthsstring · enumOptional

Settings Color Depth Type.

Possible values:
graphicsAccelerationstring · enumOptional

Acceleration Mode Type.

Possible values:
printingEnabledboolean · nullableOptional

Printing: Whether Printing Policy is enabled or not.

redirectPrinterTechstring · enumOptional

Printing Technology Use Type.

Possible values:
redirectPrintersstring · enumOptional

Universal Printing Type.

Possible values:
redirectPrintersListstring[] · nullableOptional

Printing: List of names of printers that are used to redirect to.

scanningEnabledboolean · nullableOptional

Scanning: Whether Scanning policy is enabled or not.

scanTechstring · enumOptional

Scanning Technology Use Type.

Possible values:
scanRedirectstring · enumOptional

Redirect Scanner Type.

Possible values:
scanListTwainstring[] · nullableOptional

Scanning: The TWAIN scanning List.

scanListWiastring[] · nullableOptional

Scanning: The WIA scanning List.

audioEnabledboolean · nullableOptional

Audio: Whether Audio policy is enabled or not.

audioModesstring · enumOptional

Audio Mode Type.

Possible values:
audioQualitystring · enumOptional

Audio Quality Type.

Possible values:
audioRecboolean · nullableOptional

Audio: Allow Audio Recording if box is ticked.

keyboardEnabledboolean · nullableOptional

Keyboard: Whether Keyboard policy is enabled or not.

keyboardWindowstring · enumOptional

Keyboard Type.

Possible values:
sendUnicodeCharsboolean · nullableOptional

Keyboard: Allow Unicode characters if the box is checked.

clipboardEnabledboolean · nullableOptional

Clipboard: Whether Local Devices and resources clipboard policy is enabled or not.

clipboardDirectionstring[Flag] · enumOptional

Clipboard Direction Type.

Possible values:
limitClipboardToTextOnlystring[Flag] · enumOptional

Limit clipboard to text only.

Possible values:
devicesEnabledboolean · nullableOptional

Devices: Whether Local Devices and resources Devices policy is enabled or not.

redirectDevicesboolean · nullableOptional

Devices: If box is checked allow devices redirection.

dynamicDevicesboolean · nullableOptional

Devices: If box is checked allow the use of other devices that are plugged in later.

useAllDevicesboolean · nullableOptional

Devices: Use all devices that are available.

redirectToDevicesstring[] · nullableOptional

Devices: Redirect to all available devices.

diskDrivesEnabledboolean · nullableOptional

Disk Drives: Whether Disk Drives policy is enabled or not.

redirectDrivesboolean · nullableOptional

Disk Drives: Allow Drives Redirection.

redirectReadonlyDrivesboolean · nullableOptional

Disk Drives: Redirect as read-only drives.

dynamicDrivesboolean · nullableOptional

Disk Drives: Allow Drives that are plugged in later on.

redirectToDrivesstring[] · nullableOptional

Disk Drives: The drives to redirect to.

useAllDrivesboolean · nullableOptional

Disk Drives: Will use all the drives that are available.

driveCacheModestring · enumOptional

Drive Cache Mode

Possible values:
avdMultimediaRedirEnabledboolean · nullableOptional

Multimedia redirection for AVD: Multimedia redirection for AVD policy is enabled or not.

avdMultimediaRedirboolean · nullableOptional

Multimedia redirection for AVD: Whether Multimedia redirection is enabled for AVD or not.

fileTransferEnabledboolean · nullableOptional

File Transfer: Whether File Transfer policy is enabled or not.

fileTransferModestring · enumOptional

File Transfer Control modes.

Possible values:
portsEnabledboolean · nullableOptional

Ports: Whether Ports policy is enabled or not.

redirectCOMPortsboolean · nullableOptional

Ports: If box is checked allow the LPT and COM Redirection.

smartCardsEnabledboolean · nullableOptional

Smart Cards: Smart Card policy is enabled or not.

redirectSmartCardsboolean · nullableOptional

Smart Cards: If box is checked allow the Smart Card Redirection.

windowsTouchInputEnabledboolean · nullableOptional

Windows Touch Input: Whether Windows Touch Input policy is enabled or not.

touchInputboolean · nullableOptional

Windows Touch Input: If box is checked allow the window touch redirection.

videoCaptureDevicesEnabledboolean · nullableOptional

Whether Video Capture Devices policy is enabled or not

enableCamerasboolean · nullableOptional

If box is checked allow devices redirection

dynamicCamerasboolean · nullableOptional

If box is checked allow the use of other devices that are plugged in later

videoCaptureUseAllDevicesboolean · nullableOptional

Use all devices that are available

camerasIdsstring[] · nullableOptional

Redirect to all available devices

performanceEnabledboolean · nullableOptional

Performance: Whether performance policy is enabled or not.

netTypestring · enumOptional

Network Type.

Possible values:
desktopBackgroundboolean · nullableOptional

Performance: If the box is checked allow the desktop background.

fontSmoothingboolean · nullableOptional

Performance: If the box is checked allow font smoothing.

windowMenuAnimationboolean · nullableOptional

Performance: If the box is checked allow for the window menu animation.

desktopCompositionboolean · nullableOptional

Performance: If the box is checked allow for the desktop composition.

themesboolean · nullableOptional

Performance: If the box is checked allow for the themes setting.

bitmapCachingboolean · nullableOptional

Performance: If the box is checked allow for bitmap caching.

moveSizeFullDragboolean · nullableOptional

Performance: Allow the resizing of windows.

showContentboolean · nullableOptional

Performance: Whether show contents of window while dragging is enabled or not.

compressionEnabledboolean · nullableOptional

Compression: Whether Compression policy is enabled or not.

compressboolean · nullableOptional

Compression: Allow for RDP compression.

scanningCompressionstring · enumOptional

Compression Type.

Possible values:
printingCompressionstring · enumOptional

Compression Type.

Possible values:
networkEnabledboolean · nullableOptional

Network: Whether Network policy is enabled or not.

useProxyServerboolean · nullableOptional

Network: Check the box if you want to use a proxy server.

proxyTypestring · enumOptional

Proxy Type.

Possible values:
proxyHoststring · min: 1 · max: 255 · nullableOptional

Network: The proxy host.

proxyPortinteger · int32 · nullableOptional

Network: The proxy port.

proxyAuthenticationboolean · nullableOptional

Network: Check the box if the proxy requires any authentication.

proxyUseLogonCredentialsboolean · nullableOptional

Network: Will use the user logon credentials.

proxyUsernamestring · min: 1 · max: 255 · nullableOptional

Network: The proxy username authentication.

serverAuthenticationEnabledboolean · nullableOptional

Server Authentication: Whether Server Authentication policy is enabled or not.

sessionAuthFailureActionstring · enumOptional

If Authentication Fail Type.

Possible values:
advancedSettingsEnabledboolean · nullableOptional

Advanced Settings: Whether Advanced Settings policy is enabled or not.

useClientColorsboolean · nullableOptional

Advanced Settings: Make use of the system client colours.

useClientSettingsboolean · nullableOptional

Advanced Settings: Make use of the system client settings.

createShrtCutboolean · nullableOptional

Advanced Settings: Creates the shortcuts on the configured server.

registerExtboolean · nullableOptional

Advanced Settings: Register file extensions associated from the server.

urlRedirectionboolean · nullableOptional

Advanced Settings: Will redirect url to the client device.

mailRedirectionboolean · nullableOptional

Advanced Settings: Will redirect the mail to the client devices.

credAlwaysAskboolean · nullableOptional

Advanced Settings: Will always ask for the credentials.

allowSrvCmdboolean · nullableOptional

Advanced Settings: Will allow server commands to be executed by the client.

promptSrvCmdboolean · nullableOptional

Advanced Settings: Will confirm the server commands before executing them.

credSSPboolean · nullableOptional

Advanced Settings: Will allow for network level authentication.

redirPOSboolean · nullableOptional

Advanced Settings: Will redirect POS devices.

pre2000Credboolean · nullableOptional

Advanced Settings: Will use pre windows 2000 format.

disableRUDPboolean · nullableOptional

Advanced Settings: Will disable rdp-udp gateway connections.

doNotShowDriveRedirectionDlgboolean · nullableOptional

Advanced Settings: Does not show the redirection drive dialog.

defaultPrinterstring · nullableOptional

Printing - Default Settings: The default printer chosen.

defaultPrinterTechstring · enumOptional

Printing Technology Use Type.

Possible values:
forceTimeinteger · int32 · nullableOptional

Printing - Default Settings: The time in Seconds to Force the Default Printer for.

matchExactPrinterNameboolean · nullableOptional

Printing - Default Settings: Match Exact Printer Name.

updateRemoteDefPrinterboolean · nullableOptional

Printing - Default Settings: Update the remote default printer.

dataFormatstring · enumOptional

Printing Data Format.

Possible values:
printerPreferencestring · enumOptional

Client Printer Preference.

Possible values:
specificPreferredPrinterstring · min: 1 · max: 255 · nullableOptional

Printing - Printing Options: The specific preferred printer.

clientOptionsEnabledboolean · nullableOptional

Client Options: Whether Client Options policy is enabled or not.

clientOptionsAppearanceEnabledboolean · nullableOptional

Client Options Appearance: Whether Client Options Appearance policy is enabled or not.

uiTypestring · enumOptional

UI Type.

Possible values:
promptSwitchToModernboolean · nullableOptional

Client Options Appearance: Will prompt user to switch to modern UI.

clientOptionsConnEnabledboolean · nullableOptional

Client Options Connection: Whether Client Options Connection policy is enabled or not.

connectionBannerTypestring · enumOptional

Connection Banner Type.

Possible values:
autoRefreshFarmsboolean · nullableOptional

Client Options Connection: Will automatically refresh the farm every given minutes.

autoRefreshTime_Minsinteger · int32 · nullableOptional

Client Options Connection: The given minutes to refresh the farm.

whenAllSessionClosedActionstring · enumOptional

When All Session Closed Action.

Possible values:
clientOptionsUpdateEnabledboolean · nullableOptional

Client Options Update: Whether Client Options Update policy is enabled or not.

checkForUpdateOnLaunchboolean · nullableOptional

Client Options Update: Will check updates on startup.

updateClientXmlUrlstring · min: 1 · max: 255 · nullableOptional

Client Options Update: The url to update the client.

updateAVDClientXMLURLstring · min: 1 · max: 255 · nullableOptional

Client Options Update: The url to update the AVD client.

clientOptionsPCKeyboardEnabledboolean · nullableOptional

Client Options PCKeyboard: Whether Client Options PCKeyboard policy is enabled or not.

forcePCKeybdboolean · nullableOptional

Client Options PCKeyboard: Will force to use the pc keyboard if applicable.

pcKeybdstring · enumOptional

Keyboard Layout.

Possible values:
ssoEnabledboolean · nullableOptional

Client Options SSO: Whether Client Options SSO policy is enabled or not.

forceThirdPartySSOboolean · nullableOptional

Client Options SSO: Will wrap third party SSO Component.

ssoProvGUIDstring · min: 1 · max: 255 · nullableOptional

Client Options SSO: The third party credientials.

loggingEnabledboolean · nullableOptional

Client Options - Logging: Whether Logging policy is enabled or not.

logLevelstring · enumOptional

Log Levels Type.

Possible values:
loggingStartDateTimestring · date-time · nullableOptional

Client Options - Logging: Logging Start DateTime.

loggingDurationinteger · int32 · nullableOptional

Client Options - Logging: Logging Duration (in seconds).

allowViewLogboolean · nullableOptional

Client Options - Logging: Whether Allow View Log is enabled or not.

allowClearLogboolean · nullableOptional

Client Options - Logging: Whether Allow Clear Log is enabled or not.

clientOptionsAdvancedEnabledboolean · nullableOptional

Client Options - Advanced: Whether Advanced policy is enabled or not.

globalEnabledboolean · nullableOptional

Client Options - Advanced - Global: Whether Advanced Global policy is enabled or not

showFoldersboolean · nullableOptional

Client Options - Advanced - Global: Show the connection trees

minimizeToTrayOnCloseboolean · nullableOptional

Client Options - Advanced - Global: Minimize to tray on close or escape

graphicsAccelboolean · nullableOptional

Client Options - Advanced - Global: Enable the graphics acceleration for the chrome client

clientWorkAreaBackgroundboolean · nullableOptional

Client Options - Advanced - Global: Enable the work area background for the chrome client

sslNoWarningboolean · nullableOptional

Client Options - Advanced - Global: Do not warn if the server certificate is not verified

swapMouseboolean · nullableOptional

Client Options - Advanced - Global: Swap the mouse buttons

dpiAwareboolean · nullableOptional

Client Options - Advanced - Global: Enable the dpi aware

autoAddFarmboolean · nullableOptional

Client Options - Advanced - Global: Add the RAS Connections automatically when starting web or shortcut items

dontPromptAutoAddFarmboolean · nullableOptional

Client Options - Advanced - Global: No messages are prompted when auto adding ras connections

suppErrMsgsboolean · nullableOptional

Client Options - Advanced - Global: Close any errors automatically

clearCookiesboolean · nullableOptional

Client Options - Advanced - Global: Clear session cookies on exit.

turnOffUDPOnClientboolean · nullableOptional

Client Options - Advanced - Global: Turn off UDP on Client.

languageEnabledboolean · nullableOptional

Client Options - Advanced - Language: Whether Language policy is enabled or not

langstring · enumOptional

Languages Type.

Possible values:
clientOptionsPrintingEnabledboolean · nullableOptional

Client Options - Advanced - Printing: Whether Printing policy is enabled or not.

printInstallFontsboolean · nullableOptional

Client Options - Advanced - Printing: Will install any missing fonts automatically.

printRawSupportboolean · nullableOptional

Client Options - Advanced - Printing: Will allow for raw printing support.

allowEMFRasterizationboolean · nullableOptional

Client Options - Advanced - Printing: Will convert non distributable fonts data to images.

printUseCacheboolean · nullableOptional

Client Options - Advanced - Printing: Will cache printer hardware information.

printRefreshCacheboolean · nullableOptional

Client Options - Advanced - Printing: Will refresh printer hardware information every 30 days.

printUseFontsCacheboolean · nullableOptional

Client Options - Advanced - Printing: Will allow for the RAS universal printing embedded fonts.

windowsClientEnabledboolean · nullableOptional

Client Options - Advanced - Windows Client: Whether Windows Client policy is enabled or not.

autoHideboolean · nullableOptional

Client Options - Advanced - Windows Client: Will hide the launcher when an application is opened.

autoLaunchboolean · nullableOptional

Client Options - Advanced - Windows Client: Will launch automatically at windows startup.

remoteFxUsbRedirEnabledboolean · nullableOptional

Client Options - Advanced - RemoteFX USB Redirection: Whether Remote Fx Usb Redirection policy is enabled or not.

remoteFXUSBRedirboolean · nullableOptional

Client Options - Advanced - RemoteFX USB Redirection: Will allow redirection of other supported remotedfx usb devices.

clientOptionsCEPEnabledboolean · nullableOptional

Client Options - Advanced - Customer Experience Program: Whether Remote Fx Usb Redirection policy is enabled or not.

participateInCEPboolean · nullableOptional

Client Options - Advanced - Customer Experience Program: Will allow redirection of other supported remotedfx usb devices.

controlSettingsConnectionEnabledboolean · nullableOptional

Control Settings Connection: Whether Control Settings Connections policy is enabled or not.

dontAddNewASXGConnsboolean · nullableOptional

Control Settings Connection: Will not be able to add a new ras connection.

dontAddNewStdConnsboolean · nullableOptional

Control Settings Connection: Will not be able to add a new rdp connection.

controlSettingsCredentialsEnabledboolean · nullableOptional

Control Settings Credentials: Whether Control Settings Credentials policy is enabled or not.

dontSaveUsernameboolean · nullableOptional

Control Settings Credentials: Will not be able to save the username.

dontSavePwdsboolean · nullableOptional

Control Settings Credentials: Will not be able to save the password.

dontChangePwdsboolean · nullableOptional

Control Settings Credentials: Will not be able to change the password.

controlSettingsImportExportEnabledboolean · nullableOptional

Control Settings Import Export: Whether Control Settings Import Export policy is enabled or not.

dontImportboolean · nullableOptional

Control Settings Import Export: Will not allow any importation of the connection settings.

dontExportboolean · nullableOptional

Control Settings Import Export: Will not allow any exportation of the connection settings.

redirectionEnabledboolean · nullableOptional

Redirection: Whether Redirection policy is enabled or not

gatewaystring · min: 1 · max: 255 · nullableOptional

Redirection: The gateway address

modestring · enumOptional

Connection Mode Type.

Possible values:
serverPortinteger · int32 · nullableOptional

Redirection: The server port

altGatewaystring · min: 1 · max: 255 · nullableOptional

Redirection: The alternative gateway address

Responses
put
/api/ClientPolicies/{id}

No content

Delete

delete

Delete a Client policy.

Path parameters
idinteger · int32Required

Client policy ID

Responses
delete
/api/ClientPolicies/{id}

No content

Last updated

Was this helpful?