Policies
Retrieve client policy/ies.
Client policy name (optional)
GET /api/ClientPolicies HTTP/1.1
Host:
Accept: */*
[
{
"id": 1,
"adminCreate": "text",
"adminLastMod": "text",
"timeCreate": "2025-07-08T09:15:48.506Z",
"timeLastMod": "2025-07-08T09:15:48.506Z",
"name": "text",
"enabled": true,
"description": "text",
"order": 1,
"clientPolicy": {
"redirection": {
"enabled": true,
"gateway": "text",
"mode": [
"0 = GatewayMode",
"1 = GatewaySSLMode",
"2 = DirectMode",
"3 = DirectSSLMode"
],
"serverPort": 1,
"altGateway": "text"
},
"session": {
"primaryConnection": {
"enabled": true,
"name": "text",
"autoLogin": true,
"authenticationType": [
"0 = Credentials",
"1 = SingleSignOn",
"2 = SmartCard",
"3 = Web",
"4 = WebCredentials"
],
"savePassword": true,
"domain": "text"
},
"secondaryConnections": {
"enabled": true,
"connectionList": [
{
"mode": [
"0 = GatewayMode",
"1 = DirectMode",
"2 = GatewaySSLMode",
"3 = DirectSSLMode"
],
"server": "text",
"serverPort": 1
}
]
},
"reconnection": {
"enabled": true,
"enableReconnection": true,
"connectionRetries": 1,
"connectionBannerDelay": 1
},
"computerName": {
"enabled": true,
"overrideComputerName": "text"
},
"connectionAdvancedSettings": {
"enabled": true,
"connectionTimeout": 1,
"connectionBannerDelay": 1,
"showDesktopTimeout": 1
},
"webAuthentication": {
"enabled": true,
"defaultOsBrowser": true,
"openBrowserOnLogout": true
},
"multiFactorAuthentication": {
"enabled": true,
"rememberLastUsedMethod": true
},
"sessionPreLaunch": {
"enabled": true,
"preLaunchMode": [
"0 = Off",
"1 = Basic",
"2 = MachineLearning"
],
"preLaunchExclude": [
"text"
]
},
"localProxyAddress": {
"enabled": true,
"useLocalHostProxyIP": true
},
"settings": {
"enabled": true,
"colorDepths": [
"0 = Colors256",
"1 = HighColor15Bit",
"2 = HighColor16Bit",
"3 = TrueColor24Bit",
"4 = HighestQuality32Bit"
],
"graphicsAcceleration": [
"0 = None",
"1 = Basic",
"2 = RemoteFx",
"3 = RemoteFxAdaptive",
"4 = AVCAdaptive"
]
},
"multiMonitor": {
"enabled": true,
"displayConfig": [
"0 = Primary",
"1 = All",
"2 = Selected"
]
},
"publishedApplications": {
"enabled": true,
"usePrimaryMonitor": true,
"useDynamicDesktopResizing": true,
"useAvailAreaForAppSingleMonitor": true
},
"desktopOptions": {
"enabled": true,
"smartSizing": [
"0 = Disabled",
"1 = Scale",
"2 = Resize"
],
"embedDesktop": true,
"spanDesktops": true,
"fullScreenBar": [
"0 = DoNotShow",
"1 = ShowPinned",
"2 = ShowUnPinned"
]
},
"browser": {
"enabled": true,
"browserOpenIn": [
"0 = SameTab",
"1 = NewTab"
]
},
"printing": {
"enabled": true,
"redirectPrinterTech": [
"0 = None",
"1 = RasUniversalPrintingTechnology",
"2 = MicrosoftBasicPrintingTechnology",
"3 = RasUniversalPrintingAndMsBasicTechnologies"
],
"redirectPrinters": [
"0 = All",
"1 = DefaultOnly",
"2 = SpecificOnly"
],
"redirectPrintersList": [
"text"
],
"printingOptions": {
"dataFormat": [
"0 = ViewPDF_ExtApp",
"1 = EMF",
"2 = BMP",
"4 = PrintPDF_ExtApp",
"5 = PrintPDF"
],
"printerPreference": [
"0 = ServerPrefAllPrinters",
"1 = ClientPrefAllPrinters",
"2 = ClientPrefSpecificPrinters"
],
"specificPreferredPrinter": "text"
},
"defaultPrintingSettings": {
"defaultPrinter": "text",
"defaultPrinterTech": [
"0 = None",
"1 = RasUniversalPrintingTechnology",
"2 = MicrosoftBasicPrintingTechnology",
"3 = RasUniversalPrintingAndMsBasicTechnologies"
],
"forceTime": 1,
"matchExactPrinterName": true,
"updateRemoteDefPrinter": true
}
},
"scanning": {
"enabled": true,
"scanTech": [
"0 = None",
"1 = WIA",
"2 = TWAIN",
"3 = WIAandTWAIN"
],
"scanRedirect": [
"0 = All",
"1 = SpecificOnly"
],
"scanListTwain": [
"text"
],
"scanListWia": [
"text"
]
},
"audio": {
"enabled": true,
"audioModes": [
"0 = BringToThisComputer",
"1 = DoNotPlay",
"2 = LeaveAtRemoteComputer"
],
"audioQuality": [
"0 = AdjustDynamically",
"1 = UseMediumQuality",
"2 = UseUncompressedQuality"
],
"audioRec": true
},
"keyboard": {
"enabled": true,
"keyboardWindow": [
"0 = LocalComputer",
"1 = RemoteComputer",
"2 = FullScreenMode"
],
"sendUnicodeChars": true
},
"clipboard": {
"enabled": true,
"clipboardDirection": [
"0 = None",
"1 = ClientToServer",
"2 = ServerToClient",
"3 = Bidirectional"
],
"limitClipboardToTextOnly": [
"0 = NoLimit",
"1 = ClientToServer",
"2 = ServerToClient",
"3 = BothDirections"
]
},
"diskDrives": {
"enabled": true,
"redirectDrives": true,
"dynamicDrives": true,
"redirectToDrives": [
"text"
],
"redirectReadonlyDrives": true,
"useAllDrives": true,
"driveCacheMode": [
"0 = Disable",
"1 = Enable",
"2 = Fast"
]
},
"devices": {
"enabled": true,
"redirectDevices": true,
"dynamicDevices": true,
"useAllDevices": true,
"redirectToDevices": [
"text"
]
},
"ports": {
"enabled": true,
"redirectCOMPorts": true
},
"smartCards": {
"enabled": true,
"redirectSmartCards": true
},
"windowsTouchInput": {
"enabled": true,
"touchInput": true
},
"videoCaptureDevices": {
"enabled": true,
"enableCameras": true,
"dynamicCameras": true,
"videoCaptureUseAllDevices": true,
"camerasIDs": [
"text"
]
},
"avdMultimediaRedirection": {
"enabled": true,
"avdMultimediaRedir": true
},
"fileTransfer": {
"enabled": true,
"fileTransferMode": [
"0 = Disabled",
"1 = ClientToServer",
"2 = ServerToClient",
"3 = Bidirectional"
]
},
"performance": {
"enabled": true,
"netType": [
"0 = Modem",
"1 = LowSpeedBroadband",
"2 = Satellite",
"3 = HighSpeedBroadband",
"4 = WAN",
"5 = LAN",
"6 = DetectConnectionQualityAuto"
],
"desktopBackground": true,
"fontSmoothing": true,
"windowMenuAnimation": true,
"desktopComposition": true,
"themes": true,
"bitmapCaching": true,
"moveSizeFullDrag": true,
"showContent": true
},
"compression": {
"enabled": true,
"compress": true,
"scanningCompression": [
"0 = CompressionDisabled",
"1 = BestSpeed",
"2 = BestSize",
"3 = BasedOnConnectionSpeed"
],
"printingCompression": [
"0 = CompressionDisabled",
"1 = BestSpeed",
"2 = BestSize",
"3 = BasedOnConnectionSpeed"
]
},
"network": {
"enabled": true,
"useProxyServer": true,
"proxyHost": "text",
"proxyPort": 1,
"proxyAuthentication": true,
"proxyUseLogonCredentials": true,
"proxyUsername": "text",
"proxyType": [
"0 = SOCKS4",
"1 = SOCKS4A",
"2 = SOCKS5",
"3 = HTTP1_1"
]
},
"advancedSettings": {
"enabled": true,
"useClientColors": true,
"useClientSettings": true,
"createShrtCut": true,
"registerExt": true,
"urlRedirection": true,
"mailRedirection": true,
"credAlwaysAsk": true,
"allowSrvCmd": true,
"promptSrvCmd": true,
"credSSP": true,
"redirPOS": true,
"pre2000Cred": true,
"disableRUDP": true,
"doNotShowDriveRedirectionDlg": true
},
"serverAuthentication": {
"enabled": true,
"sessionAuthFailureAction": [
"0 = Connect",
"1 = DoNotConnect",
"2 = Warn"
]
}
},
"clientOptions": {
"enabled": true,
"appearance": {
"enabled": true,
"uiType": [
"0 = Modern",
"1 = Classic",
"2 = User"
],
"promptSwitchToModern": true
},
"connection": {
"enabled": true,
"connectionBannerType": [
"0 = SplashWindow",
"1 = TaskBarToastWindow",
"2 = None"
],
"autoRefreshFarms": true,
"autoRefreshTime_Mins": 1,
"whenAllSessionClosedAction": [
"0 = Nothing",
"1 = LockWorkstation",
"2 = LogOff"
]
},
"logging": {
"enabled": true,
"logLevel": [
"3 = Standard",
"4 = Extended",
"5 = Verbose"
],
"loggingStartDateTime": "2025-07-08T09:15:48.506Z",
"loggingDuration": 1,
"allowViewLog": true,
"allowClearLog": true
},
"pcKeyboard": {
"enabled": true,
"forcePCKeybd": true,
"pcKeybd": [
"1028 = ChineseTraditional",
"1031 = German",
"1033 = EnglishUS",
"1034 = Spanish",
"1036 = French",
"1040 = Italian",
"1041 = Japanese",
"1042 = Korean",
"1043 = Dutch",
"1046 = PortugueseBrazil",
"1049 = Russian",
"1053 = Swedish",
"1082 = Maltese",
"2052 = ChineseSimplified",
"2057 = EnglishUK",
"2068 = NorwegianNynorsk",
"2070 = Portuguese",
"3084 = FrenchCanada"
]
},
"update": {
"enabled": true,
"checkForUpdateOnLaunch": true,
"updateClientXmlUrl": "text",
"updateAVDClientXMLURL": "text"
},
"singleSignOn": {
"enabled": true,
"forceThirdPartySSO": true,
"ssoProvGUID": "text"
},
"advanced": {
"enabled": true,
"global": {
"enabled": true,
"showFolders": true,
"minimizeToTrayOnClose": true,
"graphicsAccel": true,
"clientWorkAreaBackground": true,
"sslNoWarning": true,
"swapMouse": true,
"dpiAware": true,
"autoAddFarm": true,
"dontPromptAutoAddFarm": true,
"suppErrMsgs": true,
"clearCookies": true,
"turnOffUDPOnClient": true
},
"language": {
"enabled": true,
"lang": [
"0 = Default",
"1 = English",
"2 = German",
"3 = Japanese",
"5 = French",
"6 = Spanish",
"7 = Italian",
"8 = Portuguese",
"9 = ChineseSimplified",
"10 = ChineseTraditional",
"11 = Korean",
"12 = Dutch"
]
},
"printing": {
"enabled": true,
"printInstallFonts": true,
"printRawSupport": true,
"allowEMFRasterization": true,
"printUseCache": true,
"printRefreshCache": true,
"printUseFontsCache": true
},
"windowsClient": {
"enabled": true,
"autohide": true,
"autoLaunch": true
},
"remoteFxUsbRedirection": {
"enabled": true,
"remoteFXUSBRedir": true
},
"customerExperienceProgram": {
"enabled": true,
"participateInCEP": true
}
}
},
"controlSettings": {
"controlSettingsConnections": {
"enabled": true,
"dontAddNewASXGConns": true,
"dontAddNewStdConns": true
},
"credentials": {
"enabled": true,
"dontSaveUsername": true,
"dontSavePwds": true,
"dontChangePwds": true
},
"importExport": {
"enabled": true,
"dontImportExport": true,
"dontImport": true,
"dontExport": true
}
}
},
"version": 1,
"assignment": {
"rules": [
{
"id": 1,
"priority": 1,
"enabled": true,
"name": "text",
"description": "text",
"criteria": {
"securityPrincipals": {
"enabled": true,
"matchingMode": [
"0 = IsNotOneOfTheFollowing",
"1 = IsOneOfTheFollowing"
],
"members": [
{
"account": "text",
"type": [
"1 = User",
"2 = Group",
"3 = ForeignSecurityPrincipal",
"4 = Computer"
],
"sid": "text"
}
]
},
"gateways": {
"enabled": true,
"matchingMode": [
"0 = IsNotOneOfTheFollowing",
"1 = IsOneOfTheFollowing"
],
"members": [
{
"gatewayIP": "text"
}
]
},
"oSs": {
"enabled": true,
"matchingMode": [
"0 = IsNotOneOfTheFollowing",
"1 = IsOneOfTheFollowing"
],
"allowedOSes": {
"chrome": true,
"android": true,
"webClient": true,
"iOS": true,
"linux": true,
"mac": true,
"wyse": true,
"windows": true
}
},
"iPs": {
"enabled": true,
"matchingMode": [
"0 = IsNotOneOfTheFollowing",
"1 = IsOneOfTheFollowing"
],
"allowedIPs": {
"iPv4s": [
{
"from": "text",
"to": "text"
}
],
"iPv6s": [
{
"from": "text",
"to": "text"
}
]
}
},
"hardwareIDs": {
"enabled": true,
"matchingMode": [
"0 = IsNotOneOfTheFollowing",
"1 = IsOneOfTheFollowing"
],
"members": [
{
"hardwareID": "text"
}
]
},
"access": [
"0 = DenyCriteriaWhen",
"1 = AllowCriteriaWhen"
]
}
}
],
"default": [
"0 = Deny",
"1 = Allow"
]
}
}
]Add a new client policy.
Create a new client policy
Name of the new client policy.
Whether the new client policy will be enabled or disabled.
Description for the new client policy.
POST /api/ClientPolicies HTTP/1.1
Host:
Content-Type: application/json; api-version=1.0
Accept: */*
Content-Length: 51
{
"name": "text",
"enabled": true,
"description": "text"
}{
"id": 1,
"adminCreate": "text",
"adminLastMod": "text",
"timeCreate": "2025-07-08T09:15:48.506Z",
"timeLastMod": "2025-07-08T09:15:48.506Z",
"name": "text",
"enabled": true,
"description": "text",
"order": 1,
"clientPolicy": {
"redirection": {
"enabled": true,
"gateway": "text",
"mode": [
"0 = GatewayMode",
"1 = GatewaySSLMode",
"2 = DirectMode",
"3 = DirectSSLMode"
],
"serverPort": 1,
"altGateway": "text"
},
"session": {
"primaryConnection": {
"enabled": true,
"name": "text",
"autoLogin": true,
"authenticationType": [
"0 = Credentials",
"1 = SingleSignOn",
"2 = SmartCard",
"3 = Web",
"4 = WebCredentials"
],
"savePassword": true,
"domain": "text"
},
"secondaryConnections": {
"enabled": true,
"connectionList": [
{
"mode": [
"0 = GatewayMode",
"1 = DirectMode",
"2 = GatewaySSLMode",
"3 = DirectSSLMode"
],
"server": "text",
"serverPort": 1
}
]
},
"reconnection": {
"enabled": true,
"enableReconnection": true,
"connectionRetries": 1,
"connectionBannerDelay": 1
},
"computerName": {
"enabled": true,
"overrideComputerName": "text"
},
"connectionAdvancedSettings": {
"enabled": true,
"connectionTimeout": 1,
"connectionBannerDelay": 1,
"showDesktopTimeout": 1
},
"webAuthentication": {
"enabled": true,
"defaultOsBrowser": true,
"openBrowserOnLogout": true
},
"multiFactorAuthentication": {
"enabled": true,
"rememberLastUsedMethod": true
},
"sessionPreLaunch": {
"enabled": true,
"preLaunchMode": [
"0 = Off",
"1 = Basic",
"2 = MachineLearning"
],
"preLaunchExclude": [
"text"
]
},
"localProxyAddress": {
"enabled": true,
"useLocalHostProxyIP": true
},
"settings": {
"enabled": true,
"colorDepths": [
"0 = Colors256",
"1 = HighColor15Bit",
"2 = HighColor16Bit",
"3 = TrueColor24Bit",
"4 = HighestQuality32Bit"
],
"graphicsAcceleration": [
"0 = None",
"1 = Basic",
"2 = RemoteFx",
"3 = RemoteFxAdaptive",
"4 = AVCAdaptive"
]
},
"multiMonitor": {
"enabled": true,
"displayConfig": [
"0 = Primary",
"1 = All",
"2 = Selected"
]
},
"publishedApplications": {
"enabled": true,
"usePrimaryMonitor": true,
"useDynamicDesktopResizing": true,
"useAvailAreaForAppSingleMonitor": true
},
"desktopOptions": {
"enabled": true,
"smartSizing": [
"0 = Disabled",
"1 = Scale",
"2 = Resize"
],
"embedDesktop": true,
"spanDesktops": true,
"fullScreenBar": [
"0 = DoNotShow",
"1 = ShowPinned",
"2 = ShowUnPinned"
]
},
"browser": {
"enabled": true,
"browserOpenIn": [
"0 = SameTab",
"1 = NewTab"
]
},
"printing": {
"enabled": true,
"redirectPrinterTech": [
"0 = None",
"1 = RasUniversalPrintingTechnology",
"2 = MicrosoftBasicPrintingTechnology",
"3 = RasUniversalPrintingAndMsBasicTechnologies"
],
"redirectPrinters": [
"0 = All",
"1 = DefaultOnly",
"2 = SpecificOnly"
],
"redirectPrintersList": [
"text"
],
"printingOptions": {
"dataFormat": [
"0 = ViewPDF_ExtApp",
"1 = EMF",
"2 = BMP",
"4 = PrintPDF_ExtApp",
"5 = PrintPDF"
],
"printerPreference": [
"0 = ServerPrefAllPrinters",
"1 = ClientPrefAllPrinters",
"2 = ClientPrefSpecificPrinters"
],
"specificPreferredPrinter": "text"
},
"defaultPrintingSettings": {
"defaultPrinter": "text",
"defaultPrinterTech": [
"0 = None",
"1 = RasUniversalPrintingTechnology",
"2 = MicrosoftBasicPrintingTechnology",
"3 = RasUniversalPrintingAndMsBasicTechnologies"
],
"forceTime": 1,
"matchExactPrinterName": true,
"updateRemoteDefPrinter": true
}
},
"scanning": {
"enabled": true,
"scanTech": [
"0 = None",
"1 = WIA",
"2 = TWAIN",
"3 = WIAandTWAIN"
],
"scanRedirect": [
"0 = All",
"1 = SpecificOnly"
],
"scanListTwain": [
"text"
],
"scanListWia": [
"text"
]
},
"audio": {
"enabled": true,
"audioModes": [
"0 = BringToThisComputer",
"1 = DoNotPlay",
"2 = LeaveAtRemoteComputer"
],
"audioQuality": [
"0 = AdjustDynamically",
"1 = UseMediumQuality",
"2 = UseUncompressedQuality"
],
"audioRec": true
},
"keyboard": {
"enabled": true,
"keyboardWindow": [
"0 = LocalComputer",
"1 = RemoteComputer",
"2 = FullScreenMode"
],
"sendUnicodeChars": true
},
"clipboard": {
"enabled": true,
"clipboardDirection": [
"0 = None",
"1 = ClientToServer",
"2 = ServerToClient",
"3 = Bidirectional"
],
"limitClipboardToTextOnly": [
"0 = NoLimit",
"1 = ClientToServer",
"2 = ServerToClient",
"3 = BothDirections"
]
},
"diskDrives": {
"enabled": true,
"redirectDrives": true,
"dynamicDrives": true,
"redirectToDrives": [
"text"
],
"redirectReadonlyDrives": true,
"useAllDrives": true,
"driveCacheMode": [
"0 = Disable",
"1 = Enable",
"2 = Fast"
]
},
"devices": {
"enabled": true,
"redirectDevices": true,
"dynamicDevices": true,
"useAllDevices": true,
"redirectToDevices": [
"text"
]
},
"ports": {
"enabled": true,
"redirectCOMPorts": true
},
"smartCards": {
"enabled": true,
"redirectSmartCards": true
},
"windowsTouchInput": {
"enabled": true,
"touchInput": true
},
"videoCaptureDevices": {
"enabled": true,
"enableCameras": true,
"dynamicCameras": true,
"videoCaptureUseAllDevices": true,
"camerasIDs": [
"text"
]
},
"avdMultimediaRedirection": {
"enabled": true,
"avdMultimediaRedir": true
},
"fileTransfer": {
"enabled": true,
"fileTransferMode": [
"0 = Disabled",
"1 = ClientToServer",
"2 = ServerToClient",
"3 = Bidirectional"
]
},
"performance": {
"enabled": true,
"netType": [
"0 = Modem",
"1 = LowSpeedBroadband",
"2 = Satellite",
"3 = HighSpeedBroadband",
"4 = WAN",
"5 = LAN",
"6 = DetectConnectionQualityAuto"
],
"desktopBackground": true,
"fontSmoothing": true,
"windowMenuAnimation": true,
"desktopComposition": true,
"themes": true,
"bitmapCaching": true,
"moveSizeFullDrag": true,
"showContent": true
},
"compression": {
"enabled": true,
"compress": true,
"scanningCompression": [
"0 = CompressionDisabled",
"1 = BestSpeed",
"2 = BestSize",
"3 = BasedOnConnectionSpeed"
],
"printingCompression": [
"0 = CompressionDisabled",
"1 = BestSpeed",
"2 = BestSize",
"3 = BasedOnConnectionSpeed"
]
},
"network": {
"enabled": true,
"useProxyServer": true,
"proxyHost": "text",
"proxyPort": 1,
"proxyAuthentication": true,
"proxyUseLogonCredentials": true,
"proxyUsername": "text",
"proxyType": [
"0 = SOCKS4",
"1 = SOCKS4A",
"2 = SOCKS5",
"3 = HTTP1_1"
]
},
"advancedSettings": {
"enabled": true,
"useClientColors": true,
"useClientSettings": true,
"createShrtCut": true,
"registerExt": true,
"urlRedirection": true,
"mailRedirection": true,
"credAlwaysAsk": true,
"allowSrvCmd": true,
"promptSrvCmd": true,
"credSSP": true,
"redirPOS": true,
"pre2000Cred": true,
"disableRUDP": true,
"doNotShowDriveRedirectionDlg": true
},
"serverAuthentication": {
"enabled": true,
"sessionAuthFailureAction": [
"0 = Connect",
"1 = DoNotConnect",
"2 = Warn"
]
}
},
"clientOptions": {
"enabled": true,
"appearance": {
"enabled": true,
"uiType": [
"0 = Modern",
"1 = Classic",
"2 = User"
],
"promptSwitchToModern": true
},
"connection": {
"enabled": true,
"connectionBannerType": [
"0 = SplashWindow",
"1 = TaskBarToastWindow",
"2 = None"
],
"autoRefreshFarms": true,
"autoRefreshTime_Mins": 1,
"whenAllSessionClosedAction": [
"0 = Nothing",
"1 = LockWorkstation",
"2 = LogOff"
]
},
"logging": {
"enabled": true,
"logLevel": [
"3 = Standard",
"4 = Extended",
"5 = Verbose"
],
"loggingStartDateTime": "2025-07-08T09:15:48.506Z",
"loggingDuration": 1,
"allowViewLog": true,
"allowClearLog": true
},
"pcKeyboard": {
"enabled": true,
"forcePCKeybd": true,
"pcKeybd": [
"1028 = ChineseTraditional",
"1031 = German",
"1033 = EnglishUS",
"1034 = Spanish",
"1036 = French",
"1040 = Italian",
"1041 = Japanese",
"1042 = Korean",
"1043 = Dutch",
"1046 = PortugueseBrazil",
"1049 = Russian",
"1053 = Swedish",
"1082 = Maltese",
"2052 = ChineseSimplified",
"2057 = EnglishUK",
"2068 = NorwegianNynorsk",
"2070 = Portuguese",
"3084 = FrenchCanada"
]
},
"update": {
"enabled": true,
"checkForUpdateOnLaunch": true,
"updateClientXmlUrl": "text",
"updateAVDClientXMLURL": "text"
},
"singleSignOn": {
"enabled": true,
"forceThirdPartySSO": true,
"ssoProvGUID": "text"
},
"advanced": {
"enabled": true,
"global": {
"enabled": true,
"showFolders": true,
"minimizeToTrayOnClose": true,
"graphicsAccel": true,
"clientWorkAreaBackground": true,
"sslNoWarning": true,
"swapMouse": true,
"dpiAware": true,
"autoAddFarm": true,
"dontPromptAutoAddFarm": true,
"suppErrMsgs": true,
"clearCookies": true,
"turnOffUDPOnClient": true
},
"language": {
"enabled": true,
"lang": [
"0 = Default",
"1 = English",
"2 = German",
"3 = Japanese",
"5 = French",
"6 = Spanish",
"7 = Italian",
"8 = Portuguese",
"9 = ChineseSimplified",
"10 = ChineseTraditional",
"11 = Korean",
"12 = Dutch"
]
},
"printing": {
"enabled": true,
"printInstallFonts": true,
"printRawSupport": true,
"allowEMFRasterization": true,
"printUseCache": true,
"printRefreshCache": true,
"printUseFontsCache": true
},
"windowsClient": {
"enabled": true,
"autohide": true,
"autoLaunch": true
},
"remoteFxUsbRedirection": {
"enabled": true,
"remoteFXUSBRedir": true
},
"customerExperienceProgram": {
"enabled": true,
"participateInCEP": true
}
}
},
"controlSettings": {
"controlSettingsConnections": {
"enabled": true,
"dontAddNewASXGConns": true,
"dontAddNewStdConns": true
},
"credentials": {
"enabled": true,
"dontSaveUsername": true,
"dontSavePwds": true,
"dontChangePwds": true
},
"importExport": {
"enabled": true,
"dontImportExport": true,
"dontImport": true,
"dontExport": true
}
}
},
"version": 1,
"assignment": {
"rules": [
{
"id": 1,
"priority": 1,
"enabled": true,
"name": "text",
"description": "text",
"criteria": {
"securityPrincipals": {
"enabled": true,
"matchingMode": [
"0 = IsNotOneOfTheFollowing",
"1 = IsOneOfTheFollowing"
],
"members": [
{
"account": "text",
"type": [
"1 = User",
"2 = Group",
"3 = ForeignSecurityPrincipal",
"4 = Computer"
],
"sid": "text"
}
]
},
"gateways": {
"enabled": true,
"matchingMode": [
"0 = IsNotOneOfTheFollowing",
"1 = IsOneOfTheFollowing"
],
"members": [
{
"gatewayIP": "text"
}
]
},
"oSs": {
"enabled": true,
"matchingMode": [
"0 = IsNotOneOfTheFollowing",
"1 = IsOneOfTheFollowing"
],
"allowedOSes": {
"chrome": true,
"android": true,
"webClient": true,
"iOS": true,
"linux": true,
"mac": true,
"wyse": true,
"windows": true
}
},
"iPs": {
"enabled": true,
"matchingMode": [
"0 = IsNotOneOfTheFollowing",
"1 = IsOneOfTheFollowing"
],
"allowedIPs": {
"iPv4s": [
{
"from": "text",
"to": "text"
}
],
"iPv6s": [
{
"from": "text",
"to": "text"
}
]
}
},
"hardwareIDs": {
"enabled": true,
"matchingMode": [
"0 = IsNotOneOfTheFollowing",
"1 = IsOneOfTheFollowing"
],
"members": [
{
"hardwareID": "text"
}
]
},
"access": [
"0 = DenyCriteriaWhen",
"1 = AllowCriteriaWhen"
]
}
}
],
"default": [
"0 = Deny",
"1 = Allow"
]
}
}Retrieve a specific client policy by ID.
Client Policy ID
GET /api/ClientPolicies/{id} HTTP/1.1
Host:
Accept: */*
{
"id": 1,
"adminCreate": "text",
"adminLastMod": "text",
"timeCreate": "2025-07-08T09:15:48.506Z",
"timeLastMod": "2025-07-08T09:15:48.506Z",
"name": "text",
"enabled": true,
"description": "text",
"order": 1,
"clientPolicy": {
"redirection": {
"enabled": true,
"gateway": "text",
"mode": [
"0 = GatewayMode",
"1 = GatewaySSLMode",
"2 = DirectMode",
"3 = DirectSSLMode"
],
"serverPort": 1,
"altGateway": "text"
},
"session": {
"primaryConnection": {
"enabled": true,
"name": "text",
"autoLogin": true,
"authenticationType": [
"0 = Credentials",
"1 = SingleSignOn",
"2 = SmartCard",
"3 = Web",
"4 = WebCredentials"
],
"savePassword": true,
"domain": "text"
},
"secondaryConnections": {
"enabled": true,
"connectionList": [
{
"mode": [
"0 = GatewayMode",
"1 = DirectMode",
"2 = GatewaySSLMode",
"3 = DirectSSLMode"
],
"server": "text",
"serverPort": 1
}
]
},
"reconnection": {
"enabled": true,
"enableReconnection": true,
"connectionRetries": 1,
"connectionBannerDelay": 1
},
"computerName": {
"enabled": true,
"overrideComputerName": "text"
},
"connectionAdvancedSettings": {
"enabled": true,
"connectionTimeout": 1,
"connectionBannerDelay": 1,
"showDesktopTimeout": 1
},
"webAuthentication": {
"enabled": true,
"defaultOsBrowser": true,
"openBrowserOnLogout": true
},
"multiFactorAuthentication": {
"enabled": true,
"rememberLastUsedMethod": true
},
"sessionPreLaunch": {
"enabled": true,
"preLaunchMode": [
"0 = Off",
"1 = Basic",
"2 = MachineLearning"
],
"preLaunchExclude": [
"text"
]
},
"localProxyAddress": {
"enabled": true,
"useLocalHostProxyIP": true
},
"settings": {
"enabled": true,
"colorDepths": [
"0 = Colors256",
"1 = HighColor15Bit",
"2 = HighColor16Bit",
"3 = TrueColor24Bit",
"4 = HighestQuality32Bit"
],
"graphicsAcceleration": [
"0 = None",
"1 = Basic",
"2 = RemoteFx",
"3 = RemoteFxAdaptive",
"4 = AVCAdaptive"
]
},
"multiMonitor": {
"enabled": true,
"displayConfig": [
"0 = Primary",
"1 = All",
"2 = Selected"
]
},
"publishedApplications": {
"enabled": true,
"usePrimaryMonitor": true,
"useDynamicDesktopResizing": true,
"useAvailAreaForAppSingleMonitor": true
},
"desktopOptions": {
"enabled": true,
"smartSizing": [
"0 = Disabled",
"1 = Scale",
"2 = Resize"
],
"embedDesktop": true,
"spanDesktops": true,
"fullScreenBar": [
"0 = DoNotShow",
"1 = ShowPinned",
"2 = ShowUnPinned"
]
},
"browser": {
"enabled": true,
"browserOpenIn": [
"0 = SameTab",
"1 = NewTab"
]
},
"printing": {
"enabled": true,
"redirectPrinterTech": [
"0 = None",
"1 = RasUniversalPrintingTechnology",
"2 = MicrosoftBasicPrintingTechnology",
"3 = RasUniversalPrintingAndMsBasicTechnologies"
],
"redirectPrinters": [
"0 = All",
"1 = DefaultOnly",
"2 = SpecificOnly"
],
"redirectPrintersList": [
"text"
],
"printingOptions": {
"dataFormat": [
"0 = ViewPDF_ExtApp",
"1 = EMF",
"2 = BMP",
"4 = PrintPDF_ExtApp",
"5 = PrintPDF"
],
"printerPreference": [
"0 = ServerPrefAllPrinters",
"1 = ClientPrefAllPrinters",
"2 = ClientPrefSpecificPrinters"
],
"specificPreferredPrinter": "text"
},
"defaultPrintingSettings": {
"defaultPrinter": "text",
"defaultPrinterTech": [
"0 = None",
"1 = RasUniversalPrintingTechnology",
"2 = MicrosoftBasicPrintingTechnology",
"3 = RasUniversalPrintingAndMsBasicTechnologies"
],
"forceTime": 1,
"matchExactPrinterName": true,
"updateRemoteDefPrinter": true
}
},
"scanning": {
"enabled": true,
"scanTech": [
"0 = None",
"1 = WIA",
"2 = TWAIN",
"3 = WIAandTWAIN"
],
"scanRedirect": [
"0 = All",
"1 = SpecificOnly"
],
"scanListTwain": [
"text"
],
"scanListWia": [
"text"
]
},
"audio": {
"enabled": true,
"audioModes": [
"0 = BringToThisComputer",
"1 = DoNotPlay",
"2 = LeaveAtRemoteComputer"
],
"audioQuality": [
"0 = AdjustDynamically",
"1 = UseMediumQuality",
"2 = UseUncompressedQuality"
],
"audioRec": true
},
"keyboard": {
"enabled": true,
"keyboardWindow": [
"0 = LocalComputer",
"1 = RemoteComputer",
"2 = FullScreenMode"
],
"sendUnicodeChars": true
},
"clipboard": {
"enabled": true,
"clipboardDirection": [
"0 = None",
"1 = ClientToServer",
"2 = ServerToClient",
"3 = Bidirectional"
],
"limitClipboardToTextOnly": [
"0 = NoLimit",
"1 = ClientToServer",
"2 = ServerToClient",
"3 = BothDirections"
]
},
"diskDrives": {
"enabled": true,
"redirectDrives": true,
"dynamicDrives": true,
"redirectToDrives": [
"text"
],
"redirectReadonlyDrives": true,
"useAllDrives": true,
"driveCacheMode": [
"0 = Disable",
"1 = Enable",
"2 = Fast"
]
},
"devices": {
"enabled": true,
"redirectDevices": true,
"dynamicDevices": true,
"useAllDevices": true,
"redirectToDevices": [
"text"
]
},
"ports": {
"enabled": true,
"redirectCOMPorts": true
},
"smartCards": {
"enabled": true,
"redirectSmartCards": true
},
"windowsTouchInput": {
"enabled": true,
"touchInput": true
},
"videoCaptureDevices": {
"enabled": true,
"enableCameras": true,
"dynamicCameras": true,
"videoCaptureUseAllDevices": true,
"camerasIDs": [
"text"
]
},
"avdMultimediaRedirection": {
"enabled": true,
"avdMultimediaRedir": true
},
"fileTransfer": {
"enabled": true,
"fileTransferMode": [
"0 = Disabled",
"1 = ClientToServer",
"2 = ServerToClient",
"3 = Bidirectional"
]
},
"performance": {
"enabled": true,
"netType": [
"0 = Modem",
"1 = LowSpeedBroadband",
"2 = Satellite",
"3 = HighSpeedBroadband",
"4 = WAN",
"5 = LAN",
"6 = DetectConnectionQualityAuto"
],
"desktopBackground": true,
"fontSmoothing": true,
"windowMenuAnimation": true,
"desktopComposition": true,
"themes": true,
"bitmapCaching": true,
"moveSizeFullDrag": true,
"showContent": true
},
"compression": {
"enabled": true,
"compress": true,
"scanningCompression": [
"0 = CompressionDisabled",
"1 = BestSpeed",
"2 = BestSize",
"3 = BasedOnConnectionSpeed"
],
"printingCompression": [
"0 = CompressionDisabled",
"1 = BestSpeed",
"2 = BestSize",
"3 = BasedOnConnectionSpeed"
]
},
"network": {
"enabled": true,
"useProxyServer": true,
"proxyHost": "text",
"proxyPort": 1,
"proxyAuthentication": true,
"proxyUseLogonCredentials": true,
"proxyUsername": "text",
"proxyType": [
"0 = SOCKS4",
"1 = SOCKS4A",
"2 = SOCKS5",
"3 = HTTP1_1"
]
},
"advancedSettings": {
"enabled": true,
"useClientColors": true,
"useClientSettings": true,
"createShrtCut": true,
"registerExt": true,
"urlRedirection": true,
"mailRedirection": true,
"credAlwaysAsk": true,
"allowSrvCmd": true,
"promptSrvCmd": true,
"credSSP": true,
"redirPOS": true,
"pre2000Cred": true,
"disableRUDP": true,
"doNotShowDriveRedirectionDlg": true
},
"serverAuthentication": {
"enabled": true,
"sessionAuthFailureAction": [
"0 = Connect",
"1 = DoNotConnect",
"2 = Warn"
]
}
},
"clientOptions": {
"enabled": true,
"appearance": {
"enabled": true,
"uiType": [
"0 = Modern",
"1 = Classic",
"2 = User"
],
"promptSwitchToModern": true
},
"connection": {
"enabled": true,
"connectionBannerType": [
"0 = SplashWindow",
"1 = TaskBarToastWindow",
"2 = None"
],
"autoRefreshFarms": true,
"autoRefreshTime_Mins": 1,
"whenAllSessionClosedAction": [
"0 = Nothing",
"1 = LockWorkstation",
"2 = LogOff"
]
},
"logging": {
"enabled": true,
"logLevel": [
"3 = Standard",
"4 = Extended",
"5 = Verbose"
],
"loggingStartDateTime": "2025-07-08T09:15:48.506Z",
"loggingDuration": 1,
"allowViewLog": true,
"allowClearLog": true
},
"pcKeyboard": {
"enabled": true,
"forcePCKeybd": true,
"pcKeybd": [
"1028 = ChineseTraditional",
"1031 = German",
"1033 = EnglishUS",
"1034 = Spanish",
"1036 = French",
"1040 = Italian",
"1041 = Japanese",
"1042 = Korean",
"1043 = Dutch",
"1046 = PortugueseBrazil",
"1049 = Russian",
"1053 = Swedish",
"1082 = Maltese",
"2052 = ChineseSimplified",
"2057 = EnglishUK",
"2068 = NorwegianNynorsk",
"2070 = Portuguese",
"3084 = FrenchCanada"
]
},
"update": {
"enabled": true,
"checkForUpdateOnLaunch": true,
"updateClientXmlUrl": "text",
"updateAVDClientXMLURL": "text"
},
"singleSignOn": {
"enabled": true,
"forceThirdPartySSO": true,
"ssoProvGUID": "text"
},
"advanced": {
"enabled": true,
"global": {
"enabled": true,
"showFolders": true,
"minimizeToTrayOnClose": true,
"graphicsAccel": true,
"clientWorkAreaBackground": true,
"sslNoWarning": true,
"swapMouse": true,
"dpiAware": true,
"autoAddFarm": true,
"dontPromptAutoAddFarm": true,
"suppErrMsgs": true,
"clearCookies": true,
"turnOffUDPOnClient": true
},
"language": {
"enabled": true,
"lang": [
"0 = Default",
"1 = English",
"2 = German",
"3 = Japanese",
"5 = French",
"6 = Spanish",
"7 = Italian",
"8 = Portuguese",
"9 = ChineseSimplified",
"10 = ChineseTraditional",
"11 = Korean",
"12 = Dutch"
]
},
"printing": {
"enabled": true,
"printInstallFonts": true,
"printRawSupport": true,
"allowEMFRasterization": true,
"printUseCache": true,
"printRefreshCache": true,
"printUseFontsCache": true
},
"windowsClient": {
"enabled": true,
"autohide": true,
"autoLaunch": true
},
"remoteFxUsbRedirection": {
"enabled": true,
"remoteFXUSBRedir": true
},
"customerExperienceProgram": {
"enabled": true,
"participateInCEP": true
}
}
},
"controlSettings": {
"controlSettingsConnections": {
"enabled": true,
"dontAddNewASXGConns": true,
"dontAddNewStdConns": true
},
"credentials": {
"enabled": true,
"dontSaveUsername": true,
"dontSavePwds": true,
"dontChangePwds": true
},
"importExport": {
"enabled": true,
"dontImportExport": true,
"dontImport": true,
"dontExport": true
}
}
},
"version": 1,
"assignment": {
"rules": [
{
"id": 1,
"priority": 1,
"enabled": true,
"name": "text",
"description": "text",
"criteria": {
"securityPrincipals": {
"enabled": true,
"matchingMode": [
"0 = IsNotOneOfTheFollowing",
"1 = IsOneOfTheFollowing"
],
"members": [
{
"account": "text",
"type": [
"1 = User",
"2 = Group",
"3 = ForeignSecurityPrincipal",
"4 = Computer"
],
"sid": "text"
}
]
},
"gateways": {
"enabled": true,
"matchingMode": [
"0 = IsNotOneOfTheFollowing",
"1 = IsOneOfTheFollowing"
],
"members": [
{
"gatewayIP": "text"
}
]
},
"oSs": {
"enabled": true,
"matchingMode": [
"0 = IsNotOneOfTheFollowing",
"1 = IsOneOfTheFollowing"
],
"allowedOSes": {
"chrome": true,
"android": true,
"webClient": true,
"iOS": true,
"linux": true,
"mac": true,
"wyse": true,
"windows": true
}
},
"iPs": {
"enabled": true,
"matchingMode": [
"0 = IsNotOneOfTheFollowing",
"1 = IsOneOfTheFollowing"
],
"allowedIPs": {
"iPv4s": [
{
"from": "text",
"to": "text"
}
],
"iPv6s": [
{
"from": "text",
"to": "text"
}
]
}
},
"hardwareIDs": {
"enabled": true,
"matchingMode": [
"0 = IsNotOneOfTheFollowing",
"1 = IsOneOfTheFollowing"
],
"members": [
{
"hardwareID": "text"
}
]
},
"access": [
"0 = DenyCriteriaWhen",
"1 = AllowCriteriaWhen"
]
}
}
],
"default": [
"0 = Deny",
"1 = Allow"
]
}
}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.
Client policy ID
Update a RAS Client Policy
The new name of the specified client policy.
Enable or disable the specified client policy.
A user-defined description for the client policy.
The order of the client policy.
Primary Connection: Whether Primary Connection is enabled or not.
Primary Connection: The name of the primary connection.
Primary Connection: Allow the user to auto login.
Authentication Type.
Primary Connection: Password will be saved when user successfully logs in.
Primary Connection: The name of the domain.
Secondary Connection: If Secondary Connection is enabled or not.
Reconnection: If Reconnection Flag is enabled or not.
Reconnection: When the connection drops allows for automatic reconnection.
Reconnection: The amount of connection retries.
Reconnection: If connection is not established after an amount of seconds given, the banner will show.
Computer Name: Whether Computer Name is enabled or not.
Computer Name: The computer name which can be overridden.
Connection Advanced Settings: Whether Connection Advanced Settings is enabled or not.
Connection Advanced Settings: The total number of seconds where the connection will timeout.
Connection Advanced Settings: If connection is not established after an amount of seconds given, the banner will show.
Connection Advanced Settings: If published application does not start after several seconds this will show.
Web Authentication: Whether the web authentication is enabled or not.
Web Authentication: If the box is checked the os will use the default browser.
Web Authentication: Whether the browser is shown when logging out of web authentication with the internal browser.
Multi Factor Authentication: Whether Multi factor authentication is enabled or not.
Multi Factor Authentication: Will remember the last used method.
Session Prelaunch: Whether Session PreLaunch was enabled or not.
Session Mode Type.
Local Proxy Address: Whether Local Proxy Address is enabled or not.
Local Proxy Address: Whether the 127.0.0.1 IP address is used when using Gateway mode in VPN scenarios or not.
Session Prelaunch: The list of the session prelaunch.
Browser: Whether Display Settings Browser is enabled or not.
Open Applications In Type.
Desktop Options: Whether Display Settings Options is enabled or not.
Smart Sizing Type.
Desktop Options: If box is checked the desktop will always be fixed.
Desktop Options: If box is checked the desktop will spanned across all other monitors.
Connection Bar Type.
Multi Monitor: Whether Display Settings is enabled or not.
Display configuration Type.
Published Applications: Use the primary monitor only.
Published Applications: Use dynamic desktop resizing.
Published Applications: Use available area for an application on a single monitor (User Portal).
Settings: Whether Display Settings is enabled or not.
Settings Color Depth Type.
Acceleration Mode Type.
Printing: Whether Printing Policy is enabled or not.
Printing Technology Use Type.
Universal Printing Type.
Printing: List of names of printers that are used to redirect to.
Scanning: Whether Scanning policy is enabled or not.
Scanning Technology Use Type.
Redirect Scanner Type.
Scanning: The TWAIN scanning List.
Scanning: The WIA scanning List.
Audio: Whether Audio policy is enabled or not.
Audio Mode Type.
Audio Quality Type.
Audio: Allow Audio Recording if box is ticked.
Keyboard: Whether Keyboard policy is enabled or not.
Keyboard Type.
Keyboard: Allow Unicode characters if the box is checked.
Clipboard: Whether Local Devices and resources clipboard policy is enabled or not.
Clipboard Direction Type.
Limit clipboard to text only.
Devices: Whether Local Devices and resources Devices policy is enabled or not.
Devices: If box is checked allow devices redirection.
Devices: If box is checked allow the use of other devices that are plugged in later.
Devices: Use all devices that are available.
Devices: Redirect to all available devices.
Disk Drives: Whether Disk Drives policy is enabled or not.
Disk Drives: Allow Drives Redirection.
Disk Drives: Redirect as read-only drives.
Disk Drives: Allow Drives that are plugged in later on.
Disk Drives: The drives to redirect to.
Disk Drives: Will use all the drives that are available.
Drive Cache Mode
Multimedia redirection for AVD: Multimedia redirection for AVD policy is enabled or not.
Multimedia redirection for AVD: Whether Multimedia redirection is enabled for AVD or not.
File Transfer: Whether File Transfer policy is enabled or not.
File Transfer Control modes.
Ports: Whether Ports policy is enabled or not.
Ports: If box is checked allow the LPT and COM Redirection.
Smart Cards: Smart Card policy is enabled or not.
Smart Cards: If box is checked allow the Smart Card Redirection.
Windows Touch Input: Whether Windows Touch Input policy is enabled or not.
Windows Touch Input: If box is checked allow the window touch redirection.
Whether Video Capture Devices policy is enabled or not
If box is checked allow devices redirection
If box is checked allow the use of other devices that are plugged in later
Use all devices that are available
Redirect to all available devices
Performance: Whether performance policy is enabled or not.
Network Type.
Performance: If the box is checked allow the desktop background.
Performance: If the box is checked allow font smoothing.
Performance: If the box is checked allow for the window menu animation.
Performance: If the box is checked allow for the desktop composition.
Performance: If the box is checked allow for the themes setting.
Performance: If the box is checked allow for bitmap caching.
Performance: Allow the resizing of windows.
Performance: Whether show contents of window while dragging is enabled or not.
Compression: Whether Compression policy is enabled or not.
Compression: Allow for RDP compression.
Compression Type.
Compression Type.
Network: Whether Network policy is enabled or not.
Network: Check the box if you want to use a proxy server.
Proxy Type.
Network: The proxy host.
Network: The proxy port.
Network: Check the box if the proxy requires any authentication.
Network: Will use the user logon credentials.
Network: The proxy username authentication.
Server Authentication: Whether Server Authentication policy is enabled or not.
If Authentication Fail Type.
Advanced Settings: Whether Advanced Settings policy is enabled or not.
Advanced Settings: Make use of the system client colours.
Advanced Settings: Make use of the system client settings.
Advanced Settings: Creates the shortcuts on the configured server.
Advanced Settings: Register file extensions associated from the server.
Advanced Settings: Will redirect url to the client device.
Advanced Settings: Will redirect the mail to the client devices.
Advanced Settings: Will always ask for the credentials.
Advanced Settings: Will allow server commands to be executed by the client.
Advanced Settings: Will confirm the server commands before executing them.
Advanced Settings: Will allow for network level authentication.
Advanced Settings: Will redirect POS devices.
Advanced Settings: Will use pre windows 2000 format.
Advanced Settings: Will disable rdp-udp gateway connections.
Advanced Settings: Does not show the redirection drive dialog.
Printing - Default Settings: The default printer chosen.
Printing Technology Use Type.
Printing - Default Settings: The time in Seconds to Force the Default Printer for.
Printing - Default Settings: Match Exact Printer Name.
Printing - Default Settings: Update the remote default printer.
Printing Data Format.
Client Printer Preference.
Printing - Printing Options: The specific preferred printer.
Client Options: Whether Client Options policy is enabled or not.
Client Options Appearance: Whether Client Options Appearance policy is enabled or not.
UI Type.
Client Options Appearance: Will prompt user to switch to modern UI.
Client Options Connection: Whether Client Options Connection policy is enabled or not.
Connection Banner Type.
Client Options Connection: Will automatically refresh the farm every given minutes.
Client Options Connection: The given minutes to refresh the farm.
When All Session Closed Action.
Client Options Update: Whether Client Options Update policy is enabled or not.
Client Options Update: Will check updates on startup.
Client Options Update: The url to update the client.
Client Options Update: The url to update the AVD client.
Client Options PCKeyboard: Whether Client Options PCKeyboard policy is enabled or not.
Client Options PCKeyboard: Will force to use the pc keyboard if applicable.
Keyboard Layout.
Client Options SSO: Whether Client Options SSO policy is enabled or not.
Client Options SSO: Will wrap third party SSO Component.
Client Options SSO: The third party credientials.
Client Options - Logging: Whether Logging policy is enabled or not.
Log Levels Type.
Client Options - Logging: Logging Start DateTime.
Client Options - Logging: Logging Duration (in seconds).
Client Options - Logging: Whether Allow View Log is enabled or not.
Client Options - Logging: Whether Allow Clear Log is enabled or not.
Client Options - Advanced: Whether Advanced policy is enabled or not.
Client Options - Advanced - Global: Whether Advanced Global policy is enabled or not
Client Options - Advanced - Global: Show the connection trees
Client Options - Advanced - Global: Minimize to tray on close or escape
Client Options - Advanced - Global: Enable the graphics acceleration for the chrome client
Client Options - Advanced - Global: Enable the work area background for the chrome client
Client Options - Advanced - Global: Do not warn if the server certificate is not verified
Client Options - Advanced - Global: Swap the mouse buttons
Client Options - Advanced - Global: Enable the dpi aware
Client Options - Advanced - Global: Add the RAS Connections automatically when starting web or shortcut items
Client Options - Advanced - Global: No messages are prompted when auto adding ras connections
Client Options - Advanced - Global: Close any errors automatically
Client Options - Advanced - Global: Clear session cookies on exit.
Client Options - Advanced - Global: Turn off UDP on Client.
Client Options - Advanced - Language: Whether Language policy is enabled or not
Languages Type.
Client Options - Advanced - Printing: Whether Printing policy is enabled or not.
Client Options - Advanced - Printing: Will install any missing fonts automatically.
Client Options - Advanced - Printing: Will allow for raw printing support.
Client Options - Advanced - Printing: Will convert non distributable fonts data to images.
Client Options - Advanced - Printing: Will cache printer hardware information.
Client Options - Advanced - Printing: Will refresh printer hardware information every 30 days.
Client Options - Advanced - Printing: Will allow for the RAS universal printing embedded fonts.
Client Options - Advanced - Windows Client: Whether Windows Client policy is enabled or not.
Client Options - Advanced - Windows Client: Will hide the launcher when an application is opened.
Client Options - Advanced - Windows Client: Will launch automatically at windows startup.
Client Options - Advanced - RemoteFX USB Redirection: Whether Remote Fx Usb Redirection policy is enabled or not.
Client Options - Advanced - RemoteFX USB Redirection: Will allow redirection of other supported remotedfx usb devices.
Client Options - Advanced - Customer Experience Program: Whether Remote Fx Usb Redirection policy is enabled or not.
Client Options - Advanced - Customer Experience Program: Will allow redirection of other supported remotedfx usb devices.
Control Settings Connection: Whether Control Settings Connections policy is enabled or not.
Control Settings Connection: Will not be able to add a new ras connection.
Control Settings Connection: Will not be able to add a new rdp connection.
Control Settings Credentials: Whether Control Settings Credentials policy is enabled or not.
Control Settings Credentials: Will not be able to save the username.
Control Settings Credentials: Will not be able to save the password.
Control Settings Credentials: Will not be able to change the password.
Control Settings Import Export: Whether Control Settings Import Export policy is enabled or not.
Control Settings Import Export: Will not allow any importation of the connection settings.
Control Settings Import Export: Will not allow any exportation of the connection settings.
Redirection: Whether Redirection policy is enabled or not
Redirection: The gateway address
Connection Mode Type.
Redirection: The server port
Redirection: The alternative gateway address
PUT /api/ClientPolicies/{id} HTTP/1.1
Host:
Content-Type: application/json; api-version=1.0
Accept: */*
Content-Length: 7781
{
"name": "text",
"enabled": true,
"description": "text",
"order": 1,
"primaryConnectionEnabled": true,
"connectionName": "text",
"autoLogin": true,
"authenticationType": [
"0 = Credentials",
"1 = SingleSignOn",
"2 = SmartCard",
"3 = Web",
"4 = WebCredentials"
],
"savePassword": true,
"domain": "text",
"secondaryConnectionsEnabled": true,
"reconnectIfDropped": true,
"reconnectionEnabled": true,
"connectionRetries": 1,
"reconnectionConnectionBannerDelay": 1,
"computerNameEnabled": true,
"overrideComputerName": "text",
"connectionAdvancedSettEnabled": true,
"connectionTimeout": 1,
"connectionAdvancedSettConnectionBannerDelay": 1,
"showDesktopTimeout": 1,
"webAuthenticationEnabled": true,
"defaultOsBrowser": true,
"openBrowserOnLogout": true,
"multiFactorAuthenticationEnabled": true,
"rememberLastUsedMethod": true,
"sessionPreLaunchEnabled": true,
"preLaunchMode": [
"0 = Off",
"1 = Basic",
"2 = MachineLearning"
],
"localProxyAddressEnabled": true,
"useLocalHostProxyIP": true,
"preLaunchExclude": [
"text"
],
"browserEnabled": true,
"browserOpenIn": [
"0 = SameTab",
"1 = NewTab"
],
"desktopOptionsEnabled": true,
"smartSizing": [
"0 = Disabled",
"1 = Scale",
"2 = Resize"
],
"embedDesktop": true,
"spanDesktops": true,
"fullScreenBar": [
"0 = DoNotShow",
"1 = ShowPinned",
"2 = ShowUnPinned"
],
"multiMonitorEnabled": true,
"displayConfig": [
"0 = Primary",
"1 = All",
"2 = Selected"
],
"publishedApplicationsEnabled": true,
"usePrimaryMonitor": true,
"useDynamicDesktopResizing": true,
"useAvailAreaForAppSingleMonitor": true,
"settingsEnabled": true,
"colorDepths": [
"0 = Colors256",
"1 = HighColor15Bit",
"2 = HighColor16Bit",
"3 = TrueColor24Bit",
"4 = HighestQuality32Bit"
],
"graphicsAcceleration": [
"0 = None",
"1 = Basic",
"2 = RemoteFx",
"3 = RemoteFxAdaptive",
"4 = AVCAdaptive"
],
"printingEnabled": true,
"redirectPrinterTech": [
"0 = None",
"1 = RasUniversalPrintingTechnology",
"2 = MicrosoftBasicPrintingTechnology",
"3 = RasUniversalPrintingAndMsBasicTechnologies"
],
"redirectPrinters": [
"0 = All",
"1 = DefaultOnly",
"2 = SpecificOnly"
],
"redirectPrintersList": [
"text"
],
"scanningEnabled": true,
"scanTech": [
"0 = None",
"1 = WIA",
"2 = TWAIN",
"3 = WIAandTWAIN"
],
"scanRedirect": [
"0 = All",
"1 = SpecificOnly"
],
"scanListTwain": [
"text"
],
"scanListWia": [
"text"
],
"audioEnabled": true,
"audioModes": [
"0 = BringToThisComputer",
"1 = DoNotPlay",
"2 = LeaveAtRemoteComputer"
],
"audioQuality": [
"0 = AdjustDynamically",
"1 = UseMediumQuality",
"2 = UseUncompressedQuality"
],
"audioRec": true,
"keyboardEnabled": true,
"keyboardWindow": [
"0 = LocalComputer",
"1 = RemoteComputer",
"2 = FullScreenMode"
],
"sendUnicodeChars": true,
"clipboardEnabled": true,
"clipboardDirection": [
"0 = None",
"1 = ClientToServer",
"2 = ServerToClient",
"3 = Bidirectional"
],
"limitClipboardToTextOnly": [
"0 = NoLimit",
"1 = ClientToServer",
"2 = ServerToClient",
"3 = BothDirections"
],
"devicesEnabled": true,
"redirectDevices": true,
"dynamicDevices": true,
"useAllDevices": true,
"redirectToDevices": [
"text"
],
"diskDrivesEnabled": true,
"redirectDrives": true,
"redirectReadonlyDrives": true,
"dynamicDrives": true,
"redirectToDrives": [
"text"
],
"useAllDrives": true,
"driveCacheMode": [
"0 = Disable",
"1 = Enable",
"2 = Fast"
],
"avdMultimediaRedirEnabled": true,
"avdMultimediaRedir": true,
"fileTransferEnabled": true,
"fileTransferMode": [
"0 = Disabled",
"1 = ClientToServer",
"2 = ServerToClient",
"3 = Bidirectional"
],
"portsEnabled": true,
"redirectCOMPorts": true,
"smartCardsEnabled": true,
"redirectSmartCards": true,
"windowsTouchInputEnabled": true,
"touchInput": true,
"videoCaptureDevicesEnabled": true,
"enableCameras": true,
"dynamicCameras": true,
"videoCaptureUseAllDevices": true,
"camerasIds": [
"text"
],
"performanceEnabled": true,
"netType": [
"0 = Modem",
"1 = LowSpeedBroadband",
"2 = Satellite",
"3 = HighSpeedBroadband",
"4 = WAN",
"5 = LAN",
"6 = DetectConnectionQualityAuto"
],
"desktopBackground": true,
"fontSmoothing": true,
"windowMenuAnimation": true,
"desktopComposition": true,
"themes": true,
"bitmapCaching": true,
"moveSizeFullDrag": true,
"showContent": true,
"compressionEnabled": true,
"compress": true,
"scanningCompression": [
"0 = CompressionDisabled",
"1 = BestSpeed",
"2 = BestSize",
"3 = BasedOnConnectionSpeed"
],
"printingCompression": [
"0 = CompressionDisabled",
"1 = BestSpeed",
"2 = BestSize",
"3 = BasedOnConnectionSpeed"
],
"networkEnabled": true,
"useProxyServer": true,
"proxyType": [
"0 = SOCKS4",
"1 = SOCKS4A",
"2 = SOCKS5",
"3 = HTTP1_1"
],
"proxyHost": "text",
"proxyPort": 1,
"proxyAuthentication": true,
"proxyUseLogonCredentials": true,
"proxyUsername": "text",
"serverAuthenticationEnabled": true,
"sessionAuthFailureAction": [
"0 = Connect",
"1 = DoNotConnect",
"2 = Warn"
],
"advancedSettingsEnabled": true,
"useClientColors": true,
"useClientSettings": true,
"createShrtCut": true,
"registerExt": true,
"urlRedirection": true,
"mailRedirection": true,
"credAlwaysAsk": true,
"allowSrvCmd": true,
"promptSrvCmd": true,
"credSSP": true,
"redirPOS": true,
"pre2000Cred": true,
"disableRUDP": true,
"doNotShowDriveRedirectionDlg": true,
"defaultPrinter": "text",
"defaultPrinterTech": [
"0 = None",
"1 = RasUniversalPrintingTechnology",
"2 = MicrosoftBasicPrintingTechnology",
"3 = RasUniversalPrintingAndMsBasicTechnologies"
],
"forceTime": 1,
"matchExactPrinterName": true,
"updateRemoteDefPrinter": true,
"dataFormat": [
"0 = ViewPDF_ExtApp",
"1 = EMF",
"2 = BMP",
"4 = PrintPDF_ExtApp",
"5 = PrintPDF"
],
"printerPreference": [
"0 = ServerPrefAllPrinters",
"1 = ClientPrefAllPrinters",
"2 = ClientPrefSpecificPrinters"
],
"specificPreferredPrinter": "text",
"clientOptionsEnabled": true,
"clientOptionsAppearanceEnabled": true,
"uiType": [
"0 = Modern",
"1 = Classic",
"2 = User"
],
"promptSwitchToModern": true,
"clientOptionsConnEnabled": true,
"connectionBannerType": [
"0 = SplashWindow",
"1 = TaskBarToastWindow",
"2 = None"
],
"autoRefreshFarms": true,
"autoRefreshTime_Mins": 1,
"whenAllSessionClosedAction": [
"0 = Nothing",
"1 = LockWorkstation",
"2 = LogOff"
],
"clientOptionsUpdateEnabled": true,
"checkForUpdateOnLaunch": true,
"updateClientXmlUrl": "text",
"updateAVDClientXMLURL": "text",
"clientOptionsPCKeyboardEnabled": true,
"forcePCKeybd": true,
"pcKeybd": [
"1028 = ChineseTraditional",
"1031 = German",
"1033 = EnglishUS",
"1034 = Spanish",
"1036 = French",
"1040 = Italian",
"1041 = Japanese",
"1042 = Korean",
"1043 = Dutch",
"1046 = PortugueseBrazil",
"1049 = Russian",
"1053 = Swedish",
"1082 = Maltese",
"2052 = ChineseSimplified",
"2057 = EnglishUK",
"2068 = NorwegianNynorsk",
"2070 = Portuguese",
"3084 = FrenchCanada"
],
"ssoEnabled": true,
"forceThirdPartySSO": true,
"ssoProvGUID": "text",
"loggingEnabled": true,
"logLevel": [
"3 = Standard",
"4 = Extended",
"5 = Verbose"
],
"loggingStartDateTime": "2025-07-08T09:15:48.506Z",
"loggingDuration": 1,
"allowViewLog": true,
"allowClearLog": true,
"clientOptionsAdvancedEnabled": true,
"globalEnabled": true,
"showFolders": true,
"minimizeToTrayOnClose": true,
"graphicsAccel": true,
"clientWorkAreaBackground": true,
"sslNoWarning": true,
"swapMouse": true,
"dpiAware": true,
"autoAddFarm": true,
"dontPromptAutoAddFarm": true,
"suppErrMsgs": true,
"clearCookies": true,
"turnOffUDPOnClient": true,
"languageEnabled": true,
"lang": [
"0 = Default",
"1 = English",
"2 = German",
"3 = Japanese",
"5 = French",
"6 = Spanish",
"7 = Italian",
"8 = Portuguese",
"9 = ChineseSimplified",
"10 = ChineseTraditional",
"11 = Korean",
"12 = Dutch"
],
"clientOptionsPrintingEnabled": true,
"printInstallFonts": true,
"printRawSupport": true,
"allowEMFRasterization": true,
"printUseCache": true,
"printRefreshCache": true,
"printUseFontsCache": true,
"windowsClientEnabled": true,
"autoHide": true,
"autoLaunch": true,
"remoteFxUsbRedirEnabled": true,
"remoteFXUSBRedir": true,
"clientOptionsCEPEnabled": true,
"participateInCEP": true,
"controlSettingsConnectionEnabled": true,
"dontAddNewASXGConns": true,
"dontAddNewStdConns": true,
"controlSettingsCredentialsEnabled": true,
"dontSaveUsername": true,
"dontSavePwds": true,
"dontChangePwds": true,
"controlSettingsImportExportEnabled": true,
"dontImport": true,
"dontExport": true,
"redirectionEnabled": true,
"gateway": "text",
"mode": [
"0 = GatewayMode",
"1 = GatewaySSLMode",
"2 = DirectMode",
"3 = DirectSSLMode"
],
"serverPort": 1,
"altGateway": "text"
}No content
Last updated
Was this helpful?