Duplicate

Duplicate a Client policy.

POST/api/ClientPolicies/{id}/Duplicate

Path parameters

id*integer (int32)

The ID of the client policy to duplicate

Response

Created

Body

idinteger (int32)

ID of the object.

adminCreatenullable string

User who created the object.

adminLastModnullable string

User who last modified the object.

timeCreatestring (date-time)

Time when the object was created.

timeLastModstring (date-time)

Time when the object was last modified.

namenullable string

Name of the client policy.

enabledboolean

Whether the client policy is enabled or disabled.

descriptionnullable string

Description of the client policy.

orderinteger (int32)

Order of the client policy.

usersGroupsnullable array of UserFilter (object)

Users and groups that the client policy applies to (deprecated).

accountnullable string

The name of the user/group account the filter is added to.

typeUserType (enum)

User Type

1 = User,2 = Group,3 = ForeignSecurityPrincipal,4 = Computer

sidnullable string

The SID of the user/group account the filter is added to.

allowedOSesClientPolicyAllowedOperatingSystems (object)

Client Policy - Allowed Operating Systems

chromeboolean

Whether Chrome is allowed or not.

androidboolean

Whether Android is allowed or not.

webClientboolean

Whether Web Client is allowed or not.

iOSboolean

Whether iOS is allowed or not.

linuxboolean

Whether Linux is allowed or not.

macboolean

Whether MAC OS is allowed or not.

windowsboolean

Whether Windows is allowed or not.

gatewayRuleGatewayRuleType (enum)

Gateway Rule Type.

0 = Any,1 = Connected,2 = NotConnected,3 = NotConnectedToGWs

gatewayListnullable array of string

Gateway List (deprecated).

itemsstring

macRuleMACRuleType (enum)

MAC Rule Type.

0 = AnyMAC,1 = AllowedMACs,2 = NotAllowedMACs

macListnullable array of string

MAC List (deprecated).

itemsstring

clientPolicyClientPolicy (object)

Client Policy

redirectionRedirection (object)

Redirection Policy

enabledboolean

Whether Redirection policy is enabled or not

gatewaynullable string

The gateway address

modeConnectionMode (enum)

Connection Mode Type.

0 = GatewayMode,1 = GatewaySSLMode,2 = DirectMode,3 = DirectSSLMode

serverPortinteger (int32)

The server port

altGatewaynullable string

The alternative gateway address

sessionSessionPolicy (object)

Session Policy

primaryConnectionPrimaryConnection (object)

Sessions Primary Connection Policy

enabledboolean

Whether Primary Connection is enabled or not

namenullable string

The name of the connection

autoLoginboolean

Allows the user to auto login

authenticationTypeAuthType (enum)

Authentication Type.

0 = Credentials,1 = SingleSignOn,2 = SmartCard,3 = Web

savePasswordboolean

Password will be saved when user successfully logs in

domainnullable string

The name of the domain

secondaryConnectionsSecondaryConnections (object)

Sessions Secondary Connections Policy

enabledboolean

Whether Secondary Connection is enabled or not

connectionListnullable array of SecondaryConnection (object)

The Secondary Connection List

modeMode (enum)

Mode Type.

0 = GatewayMode,1 = DirectMode,2 = GatewaySSLMode,3 = DirectSSLMode

servernullable string

The Server which the user is going to connect to

serverPortinteger (int32)

The port of the server

reconnectionReconnection (object)

Sessions Reconnection Policy

enabledboolean

Whether Reconnection is enabled or not

enableReconnectionboolean

When the connection drops allows for automatic reconnection

connectionRetriesinteger (int32)

The amount of connection retries

connectionBannerDelayinteger (int32)

If connection is not established after an amount of seconds given the banner will show

computerNameComputerName (object)

Sessions Computer Name Policy

enabledboolean

Whether Reconnection is enabled or not.

overrideComputerNamenullable string

The computer name which can be overridden.

connectionAdvancedSettingsConnectionAdvancedSettings (object)

Sessions Connection Advanced Settings Policy

enabledboolean

Whether Connection Advanced Settings is enabled or not.

connectionTimeoutinteger (int32)

The total number of seconds where the connection will timeout.

connectionBannerDelayinteger (int32)

If connection is not established after an amount of seconds given the banner shows.

showDesktopTimeoutinteger (int32)

If published application does not start after several seconds a banner shows.

webAuthenticationWebAuthentication (object)

Sessions Web Authentication Policy

enabledboolean

Whether the web authentication is enabled or not

defaultOsBrowserboolean

If the box is checked the OS will use the default browser

openBrowserOnLogoutboolean

Whether the browser is shown when logging out of web authentication with the internal browser

multiFactorAuthenticationMultiFactorAuthentication (object)

Sessions Multi Factor Authentication Policy

enabledboolean

Whether the multi factor authentication is enabled or not.

rememberLastUsedMethodboolean

Remembers the last used method.

sessionPreLaunchSessionPrelaunch (object)

Sessions Prelaunch Policy

enabledboolean

Whether the Session Prelaunch is enabled or not

preLaunchModeSessionMode (enum)

Session Mode Type.

0 = Off,1 = Basic,2 = MachineLearning

preLaunchExcludenullable array of string

The values of the session pre launch.

itemsstring

localProxyAddressLocalProxyAddress (object)

Local Proxy Address Policy

enabledboolean

Whether the local proxy address is enabled or not

useLocalHostProxyIPboolean

If the box is checked the 127.0.0.1 IP address is used when using Gateway mode in VPN scenarios

settingsSettings (object)

Sessions Display Settings Policy

enabledboolean

Whether Display Settings is enabled or not.

colorDepthsSettingsColorDepth (enum)

Settings Color Depth Type.

0 = Colors256,1 = HighColor15Bit,2 = HighColor16Bit,3 = TrueColor24Bit,4 = HighestQuality32Bit

graphicsAccelerationAccelerationMode (enum)

Acceleration Mode Type.

0 = None,1 = Basic,2 = RemoteFx,3 = RemoteFxAdaptive,4 = AVCAdaptive

multiMonitorMultiMonitor (object)

Sessions Multi-Monitor Policy

enabledboolean

Whether the Multi-Monitor policy is enabled or not.

useAllMonitorsboolean

If set to true, the session will use all available monitors if applicable (deprecated).

displayConfigDisplayConfig (enum)

Display configuration Type.

0 = Primary,1 = All,2 = Selected

publishedApplicationsPublishedApplications (object)

Sessions Published Applications Policy

enabledboolean

Whether the Published Applications policy is enabled or not.

usePrimaryMonitorboolean

If set to true, will use the primary monitor only.

useDynamicDesktopResizingboolean

If set to true, will use dynamic desktop resizing.

desktopOptionsDesktopOptions (object)

Sessions Desktop Options Policy

enabledboolean

Whether Display Settings Options is enabled or not

smartSizingSmartSizing (enum)

Smart Sizing Type.

0 = Disabled,1 = Scale,2 = Resize

embedDesktopboolean

If box is checked the desktop will always be fixed

spanDesktopsboolean

If box is checked the desktop will spanned across all other monitors

fullScreenBarConnectionBar (enum)

Connection Bar Type.

0 = DoNotShow,1 = ShowPinned,2 = ShowUnPinned

browserBrowser (object)

Sessions Browser Policy

enabledboolean

Whether Display Settings Browser is enabled or not

browserOpenInOpenApplicationsIn (enum)

Open Applications In Type.

0 = SameTab,1 = NewTab

printingSessionsPrinting (object)

Sessions Printing Policy

enabledboolean

Whether Printing Policy is enabled or not

redirectPrinterTechPrintingTechnologyUse (enum)

Printing Technology Use Type.

0 = None,1 = RasUniversalPrintingTechnology,2 = MicrosoftBasicPrintingTechnology,3 = RasUniversalPrintingAndMsBasicTechnologies

redirectPrintersUniversalPrinting (enum)

Universal Printing Type.

0 = All,1 = DefaultOnly,2 = SpecificOnly

redirectPrintersListnullable array of string

List of names of printers that are used to redirect to

itemsstring

printingOptionsPrintingOptions (object)

Printing Options

dataFormatPrintingDataFormat (enum)

Printing Data Format.

0 = ViewPDF_ExtApp,1 = EMF,2 = BMP,4 = PrintPDF_ExtApp,5 = PrintPDF

printerPreferenceClientPrinterPreference (enum)

Client Printer Preference.

0 = ServerPrefAllPrinters,1 = ClientPrefAllPrinters,2 = ClientPrefSpecificPrinters

specificPreferredPrinternullable string

The Specific Preferred Printer.

defaultPrintingSettingsDefaultPrintingSettings (object)

Default Printing Settings

defaultPrinterTechPrintingTechnologyUse (enum)

Printing Technology Use Type.

0 = None,1 = RasUniversalPrintingTechnology,2 = MicrosoftBasicPrintingTechnology,3 = RasUniversalPrintingAndMsBasicTechnologies

forceTimeinteger (int32)

Force Default Printer for Seconds.

matchExactPrinterNameboolean

Match Exact Printer Name.

updateRemoteDefPrinterboolean

Update the remote default printer.

scanningScanning (object)

Sessions Scanning Policy

enabledboolean

Whether Scanning policy is enabled or not

scanTechScanningTechnologyUse (enum)

Scanning Technology Use Type.

0 = None,1 = WIA,2 = TWAIN,3 = WIAandTWAIN

scanRedirectRedirectScanner (enum)

Redirect Scanner Type.

0 = All,1 = SpecificOnly

scanListTwainnullable array of string

The scanning TWAIN list

itemsstring

scanListWianullable array of string

The scanning WIA list

itemsstring

audioAudio (object)

Sessions Audio Policy

enabledboolean

Whether Audio policy is enabled or not

audioModesAudioMode (enum)

Audio Mode Type.

0 = BringToThisComputer,1 = DoNotPlay,2 = LeaveAtRemoteComputer

audioQualityAudioQuality (enum)

Audio Quality Type.

0 = AdjustDynamically,1 = UseMediumQuality,2 = UseUncompressedQuality

audioRecboolean

Allow Audio Recording if box is ticked.

keyboardKeyboard (object)

Sessions Keyboard Policy

enabledboolean

Whether Keyboard policy is enabled or not

keyboardWindowKeyboardType (enum)

Keyboard Type.

0 = LocalComputer,1 = RemoteComputer,2 = FullScreenMode

sendUnicodeCharsboolean

Allow Unicode characters if the box is checked.

clipboardClipboard (object)

Settings about the Clipboard of the Local Devices

enabledboolean

Whether clipboard policy is enabled or not.

clipboardDirectionClipboardDirections (enum)

Clipboard Direction Type.

0 = None,1 = ClientToServer,2 = ServerToClient,3 = Bidirectional

diskDrivesDiskDrives (object)

Settings about the Disk Drives of the Local Devices

enabledboolean

Whether Disk Drives policy is enabled or not

redirectDrivesboolean

Whether Drives Redirection is enabled or not

dynamicDrivesboolean

Whether Drives that are plugged in later on are dynamically connected or not

redirectToDrivesnullable array of string

The drives to redirect to.

itemsstring

useAllDrivesboolean

Will use all the drives that are available, if set to true

driveCacheModeDriveCacheMode (enum)

Drive Cache Mode

0 = Disable,1 = Enable,2 = Fast

devicesDevices (object)

Settings about the Devices of the Local Devices

enabledboolean

Whether Devices policy is enabled or not

redirectDevicesboolean

If box is checked allow devices redirection

dynamicDevicesboolean

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

useAllDevicesboolean

Use all devices that are available

redirectToDevicesnullable array of string

Redirect to all available devices

itemsstring

portsPorts (object)

Settings about the Ports of the Local Devices

enabledboolean

Whether Ports policy is enabled or not

redirectCOMPortsboolean

If box is checked allow the LPT and COM Redirection

smartCardsSmartCards (object)

Settings about the Smart Cards of the Local Devices

enabledboolean

Whether Smart Card policy is enabled or not

redirectSmartCardsboolean

If box is checked allow the Smart Card Redirection

windowsTouchInputWindowsTouchInput (object)

Settings about the Windows Touch Input of the Local Devices

enabledboolean

Whether Windows Touch Input policy is enabled or not

touchInputboolean

If box is checked allow the window touch redirection.

videoCaptureDevicesVideoCaptureDevices (object)

Settings about the Video Capture Devices

enabledboolean

Whether Devices policy is enabled or not

enableCamerasboolean

If box is checked allow devices redirection

dynamicCamerasboolean

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

videoCaptureUseAllDevicesboolean

Use all devices that are available

camerasIDsnullable array of string

Redirect to all available devices

itemsstring

avdMultimediaRedirectionAVDMultimediaRedirection (object)

Settings about the 'Multimedia Redirection for AVD' (Experimental)

enabledboolean

Whether 'Multimedia Redirection for AVD' policy is enabled or not

avdMultimediaRedirboolean

If box is checked enable Multimedia Redirection for AVD

fileTransferFileTransfer (object)

Settings about the File Transfer of the Local Devices

enabledboolean

Whether File Transfer policy is enabled or not

fileTransferModeFileTransferControlMode (enum)

File Transfer Control modes.

0 = Disabled,1 = ClientToServer,2 = ServerToClient,3 = Bidirectional

performancePerformance (object)

Experience Perfomance Policy

enabledboolean

Whether performance policy is enabled or not

netTypeNetworkType (enum)

Network Type.

0 = Modem,1 = LowSpeedBroadband,2 = Satellite,3 = HighSpeedBroadband,4 = WAN,5 = LAN,6 = DetectConnectionQualityAuto

desktopBackgroundboolean

If the box is checked allow the desktop background

fontSmoothingboolean

If the box is checked allow font smoothing

windowMenuAnimationboolean

If the box is checked allow for the window menu animation

desktopCompositionboolean

If the box is checked allow for the desktop composition

themesboolean

If the box is checked allow for the themes setting

bitmapCachingboolean

If the box is checked allow for bitmap caching.

moveSizeFullDragboolean

Allow the resizing of windows

showContentboolean

Whether show contents of window while dragging is enabled or not

compressionCompression (object)

Experience Compression Policy

enabledboolean

Whether Compression policy is enabled or not

compressboolean

Allow for rdp compression

scanningCompressionCompressionType (enum)

Compression Type.

0 = CompressionDisabled,1 = BestSpeed,2 = BestSize,3 = BasedOnConnectionSpeed

printingCompressionCompressionType (enum)

Compression Type.

0 = CompressionDisabled,1 = BestSpeed,2 = BestSize,3 = BasedOnConnectionSpeed

networkNetwork (object)

Sessions Network Policy

enabledboolean

Whether Network policy is enabled or not

useProxyServerboolean

Check the box if you want to use a proxy server

proxyHostnullable string

The proxy host

proxyPortinteger (int32)

The proxy port

proxyAuthenticationboolean

Check the box if the proxy requires any authentication

proxyUseLogonCredentialsboolean

Will use the user logon credentials

proxyUsernamenullable string

The proxy username authentication

proxyTypeProxyType (enum)

Proxy Type.

0 = SOCKS4,1 = SOCKS4A,2 = SOCKS5,3 = HTTP1_1

advancedSettingsAdvancedSettings (object)

Sessions Advanced Settings Policy

enabledboolean

Whether Advanced Settings policy is enabled or not

useClientColorsboolean

Make use of the system client colours

useClientSettingsboolean

Make use of the system client settings

createShrtCutboolean

Creates the shortcuts on the configured server

registerExtboolean

urlRedirectionboolean

Will redirect url to the client device

mailRedirectionboolean

Will redirect the mail to the client devices

credAlwaysAskboolean

Will always ask for the credentials

allowSrvCmdboolean

Will allow server commands to be executed by the client

promptSrvCmdboolean

Will confirm the server commands before executing them

credSSPboolean

Will allow for network level authentication

redirPOSboolean

Will redirect pos devices

pre2000Credboolean

Will use pre windows 2000 format

disableRUDPboolean

Will disable rdp-udp gateway connections

doNotShowDriveRedirectionDlgboolean

Does not show the redirection drive dialog

serverAuthenticationServerAuthentication (object)

Sessions Server Authentication Policy

enabledboolean

Whether Server Authentication policy is enabled or not

sessionAuthFailureActionIfAuthenticationFail (enum)

If Authentication Fail Type.

0 = Connect,1 = DoNotConnect,2 = Warn

clientOptionsClientOptions (object)

Client Options Policy

enabledboolean

Whether Client Options policy is enabled or not

appearanceAppearance (object)

Client Options Appearance Policy

enabledboolean

Whether Client Options Appearance policy is enabled or not.

uiTypeUIType (enum)

UI Type.

0 = Modern,1 = Classic,2 = User

promptSwitchToModernboolean

Will prompt user to switch to modern UI.

connectionConnection (object)

Client Options Connection Policy

enabledboolean

Whether Client Options Connection policy is enabled or not.

connectionBannerTypeConnectionBannerType (enum)

Connection Banner Type.

0 = SplashWindow,1 = TaskBarToastWindow,2 = None

autoRefreshFarmsboolean

Will automatically refresh the farm every given minutes.

autoRefreshTime_Minsinteger (int32)

The given minutes to refresh the farm.

whenAllSessionClosedActionWhenAllSessionClosedAction (enum)

When All Session Closed Action.

0 = Nothing,1 = LockWorkstation,2 = LogOff

loggingLogging (object)

Client Options Logging Policy

enabledboolean

Whether Advanced Logging policy is enabled or not.

logLevelLogLevelsType (enum)

Log Levels Type.

3 = Standard,4 = Extended,5 = Verbose

loggingStartDateTimestring (date-time)

Logging Start DateTime.

loggingDurationinteger (int32)

Logging Duration (in seconds).

allowViewLogboolean

Whether Allow View Log is enabled or not.

allowClearLogboolean

Whether Allow Clear Log is enabled or not.

pcKeyboardPCKeyboard (object)

Client Options PC Keyboard Policy

enabledboolean

Whether Client Options PCKeyboard policy is enabled or not.

forcePCKeybdboolean

Will force to use the pc keyboard if applicable.

pcKeybdKeyboardLayout (enum)

Keyboard Layout.

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

updateUpdate (object)

Client Options Update Policy

enabledboolean

Whether Client Options Update policy is enabled or not.

checkForUpdateOnLaunchboolean

Will check updates on startup.

updateClientXmlUrlnullable string

The url to update the client.

singleSignOnSingleSignOn (object)

Client Options Single Sign-On Policy

enabledboolean

Whether Client Options SSO policy is enabled or not.

forceThirdPartySSOboolean

Will wrap third party SSO Component.

ssoProvGUIDnullable string

The third party credientials.

advancedClientOptionsAdvancedSettings (object)

Client Options Advanced Policy

enabledboolean

Whether Advanced policy is enabled or not

globalGlobalPolicy (object)

Client Options Global Policy

enabledboolean

Whether Advanced Global policy is enabled or not

showFoldersboolean

Show the connection trees

minimizeToTrayOnCloseboolean

Minimize to tray on close or escape

graphicsAccelboolean

Enable the graphics acceleration for the chrome client

clientWorkAreaBackgroundboolean

Enable the work area background for the chrome client

sslNoWarningboolean

Do not warn if the server certificate is not verified

swapMouseboolean

Swap the mouse buttons

dpiAwareboolean

Enable the dpi aware

autoAddFarmboolean

Add the RAS Connections automatically when starting web or shortcut items

dontPromptAutoAddFarmboolean

No messages are prompted when auto adding ras connections

suppErrMsgsboolean

Close any errors automatically

clearCookiesboolean

Clear session cookies on exit.

turnOffUDPOnClientboolean

Turn off UDP on Client.

languageLanguages (object)

Client Options Languages Policy

enabledboolean

Whether Language policy is enabled or not

langLanguageType (enum)

Languages Type.

0 = Default,1 = English,2 = German,3 = Japanese,5 = French,6 = Spanish,7 = Italian,8 = Portuguese,9 = ChineseSimplified,10 = ChineseTraditional,11 = Korean,12 = Dutch

printingClientOptionsPrinting (object)

Client Options Printing Policy

enabledboolean

Whether Printing policy is enabled or not.

printInstallFontsboolean

Will install any missing fonts automatically.

printRawSupportboolean

Will allow for raw printing support.

allowEMFRasterizationboolean

Will convert non distributable fonts data to images.

printUseCacheboolean

Will cache printer hardware information.

printRefreshCacheboolean

Will refresh printer hardware information every 30 days.

printUseFontsCacheboolean

Will allow for the RAS universal printing embedded fonts.

windowsClientWindowsClient (object)

Client Options Windows Client Policy

enabledboolean

Whether Windows Client policy is enabled or not.

autohideboolean

Will hide the launcher when an application is opened.

autoLaunchboolean

Will launch automatically at windows startup.

remoteFxUsbRedirectionRemoteFxUsbRedirection (object)

Client Options Remote FX USB Redirection Policy

enabledboolean

Whether Remote FX USB Redirection policy is enabled or not.

remoteFXUSBRedirboolean

Will allow redirection of other supported remoted FX USB devices.

customerExperienceProgramCustomerExperienceProgram (object)

Client Options Advanced Customer Experience Program Policy

enabledboolean

Whether Customer Experience Program policy is enabled or not

participateInCEPboolean

Whether to Participate in Customer Experience Program or not

controlSettingsControlSettings (object)

Control Settings Policy

controlSettingsConnectionsConnections (object)

Control Settings Connections Policy

enabledboolean

Whether Control Settings Connections policy is enabled or not.

dontAddNewASXGConnsboolean

Will not be able to add a new ras connections.

dontAddNewStdConnsboolean

Will not be able to add a new rdp connections.

credentialsCredentials (object)

Control Settings Credentials Policy

enabledboolean

Whether Control Settings Credentials policy is enabled or not.

dontSaveUsernameboolean

Will not be able to save the username.

dontSavePwdsboolean

Will not be able to save the password.

dontChangePwdsboolean

Will not be able to change the password.

importExportImportExport (object)

Control Settings Import Export Policy

enabledboolean

Whether Control Settings Import Export policy is enabled or not.

dontImportExportboolean

Will not allow any importation or exportation of the connection settings.

dontImportboolean

Will not allow any importation of the connection settings.

dontExportboolean

Will not allow any exportation of the connection settings.

versioninteger (int32)

Version.

assignmentClientPolicyAssignment (object)

The Client Policy Assignment object.

rulesnullable array of ClientPolicyRule (object)

idinteger (int32)

ID of the object.

priorityinteger (int32)

Priority of the object.

enabledboolean

Whether the Rule is enabled or not

namenullable string

Name of the Rule

descriptionnullable string

Description of the Rule

criteriaClientPolicyCriteria (object)

Client Policy Criteria

securityPrincipalsSecurityPrincipalsCriteria (object)

Security Principals Criteria

enabledboolean

Whether the Security Principals Criteria is enabled or not

matchingModeMatchingModeType (enum)

Matching mode type options

0 = IsNotOneOfTheFollowing,1 = IsOneOfTheFollowing

membersnullable array of SecurityPrincipalCriteriaEntry (object)

User criteria list

accountnullable string

The name of the user/group account the filter is added to.

typeUserType (enum)

User Type

1 = User,2 = Group,3 = ForeignSecurityPrincipal,4 = Computer

sidnullable string

The SID of the user/group account the filter is added to.

gatewaysGatewaysCriteria (object)

Gateways Criteria

enabledboolean

Whether the Gateways Criteria is enabled or not

matchingModeMatchingModeType (enum)

Matching mode type options

0 = IsNotOneOfTheFollowing,1 = IsOneOfTheFollowing

membersnullable array of GatewayCriteriaEntry (object)

Gateway criteria list

gatewayIPnullable string

The gateway IP.

oSsOSsCriteria (object)

OS Criteria Settings

enabledboolean

Whether the OSs Criteria is enabled or not

matchingModeMatchingModeType (enum)

Matching mode type options

0 = IsNotOneOfTheFollowing,1 = IsOneOfTheFollowing

allowedOSesAllowedOperatingSystems (object)

Allowed Operating Systems

chromeboolean

Whether Chrome is allowed or not.

androidboolean

Whether Android is allowed or not.

webClientboolean

Whether Web Client is allowed or not.

iOSboolean

Whether iOS is allowed or not.

linuxboolean

Whether Linux is allowed or not.

macboolean

Whether MAC OS is allowed or not.

wyseboolean

Whether Wyse is allowed or not.

windowsboolean

Whether Windows is allowed or not.

iPsIPsCriteria (object)

IPs Criteria

enabledboolean

Whether the IPs Criteria is enabled or not

matchingModeMatchingModeType (enum)

Matching mode type options

0 = IsNotOneOfTheFollowing,1 = IsOneOfTheFollowing

allowedIPsAllowedIPsCriteria (object)

Allowed IPs Criteria

iPv4snullable array of IPv4CriteriaEntry (object)

IPv4 criteria list

fromnullable string

tonullable string

iPv6snullable array of IPv6CriteriaEntry (object)

IPv6 criteria list

fromnullable string

tonullable string

hardwareIDsHardwareIDsCriteria (object)

Hardware IDs Criteria

enabledboolean

Whether the Hardware IDs Criteria is enabled or not

matchingModeMatchingModeType (enum)

Matching mode type options

0 = IsNotOneOfTheFollowing,1 = IsOneOfTheFollowing

membersnullable array of HardwareIDCriteriaEntry (object)

Hardware IDs criteria list

hardwareIDnullable string

The hardware ID.

accessAccessType (enum)

Access type options

0 = DenyCriteriaWhen,1 = AllowCriteriaWhen

defaultDefaultAssignmentType (enum)

Default assignment type options

0 = Deny,1 = Allow

Request

Response

Duplicate

Duplicate a Client policy.

POST/api/ClientPolicies/{id}/Duplicate

Path parameters

id*integer (int32)

The ID of the client policy to duplicate

Response

Created

Body

idinteger (int32)

ID of the object.

adminCreatenullable string

User who created the object.

adminLastModnullable string

User who last modified the object.

timeCreatestring (date-time)

Time when the object was created.

timeLastModstring (date-time)

Time when the object was last modified.

namenullable string

Name of the client policy.

enabledboolean

Whether the client policy is enabled or disabled.

descriptionnullable string

Description of the client policy.

orderinteger (int32)

Order of the client policy.

usersGroupsnullable array of UserFilter (object)

Users and groups that the client policy applies to (deprecated).

accountnullable string

The name of the user/group account the filter is added to.

typeUserType (enum)

User Type

1 = User,2 = Group,3 = ForeignSecurityPrincipal,4 = Computer

sidnullable string

The SID of the user/group account the filter is added to.

allowedOSesClientPolicyAllowedOperatingSystems (object)

Client Policy - Allowed Operating Systems

chromeboolean

Whether Chrome is allowed or not.

androidboolean

Whether Android is allowed or not.

webClientboolean

Whether Web Client is allowed or not.

iOSboolean

Whether iOS is allowed or not.

linuxboolean

Whether Linux is allowed or not.

macboolean

Whether MAC OS is allowed or not.

windowsboolean

Whether Windows is allowed or not.

gatewayRuleGatewayRuleType (enum)

Gateway Rule Type.

0 = Any,1 = Connected,2 = NotConnected,3 = NotConnectedToGWs

gatewayListnullable array of string

Gateway List (deprecated).

itemsstring

macRuleMACRuleType (enum)

MAC Rule Type.

0 = AnyMAC,1 = AllowedMACs,2 = NotAllowedMACs

macListnullable array of string

MAC List (deprecated).

itemsstring

clientPolicyClientPolicy (object)

Client Policy

redirectionRedirection (object)

Redirection Policy

enabledboolean

Whether Redirection policy is enabled or not

gatewaynullable string

The gateway address

modeConnectionMode (enum)

Connection Mode Type.

0 = GatewayMode,1 = GatewaySSLMode,2 = DirectMode,3 = DirectSSLMode

serverPortinteger (int32)

The server port

altGatewaynullable string

The alternative gateway address

sessionSessionPolicy (object)

Session Policy

primaryConnectionPrimaryConnection (object)

Sessions Primary Connection Policy

enabledboolean

Whether Primary Connection is enabled or not

namenullable string

The name of the connection

autoLoginboolean

Allows the user to auto login

authenticationTypeAuthType (enum)

Authentication Type.

0 = Credentials,1 = SingleSignOn,2 = SmartCard,3 = Web

savePasswordboolean

Password will be saved when user successfully logs in

domainnullable string

The name of the domain

secondaryConnectionsSecondaryConnections (object)

Sessions Secondary Connections Policy

enabledboolean

Whether Secondary Connection is enabled or not

connectionListnullable array of SecondaryConnection (object)

The Secondary Connection List

modeMode (enum)

Mode Type.

0 = GatewayMode,1 = DirectMode,2 = GatewaySSLMode,3 = DirectSSLMode

servernullable string

The Server which the user is going to connect to

serverPortinteger (int32)

The port of the server

reconnectionReconnection (object)

Sessions Reconnection Policy

enabledboolean

Whether Reconnection is enabled or not

enableReconnectionboolean

When the connection drops allows for automatic reconnection

connectionRetriesinteger (int32)

The amount of connection retries

connectionBannerDelayinteger (int32)

If connection is not established after an amount of seconds given the banner will show

computerNameComputerName (object)

Sessions Computer Name Policy

enabledboolean

Whether Reconnection is enabled or not.

overrideComputerNamenullable string

The computer name which can be overridden.

connectionAdvancedSettingsConnectionAdvancedSettings (object)

Sessions Connection Advanced Settings Policy

enabledboolean

Whether Connection Advanced Settings is enabled or not.

connectionTimeoutinteger (int32)

The total number of seconds where the connection will timeout.

connectionBannerDelayinteger (int32)

If connection is not established after an amount of seconds given the banner shows.

showDesktopTimeoutinteger (int32)

If published application does not start after several seconds a banner shows.

webAuthenticationWebAuthentication (object)

Sessions Web Authentication Policy

enabledboolean

Whether the web authentication is enabled or not

defaultOsBrowserboolean

If the box is checked the OS will use the default browser

openBrowserOnLogoutboolean

Whether the browser is shown when logging out of web authentication with the internal browser

multiFactorAuthenticationMultiFactorAuthentication (object)

Sessions Multi Factor Authentication Policy

enabledboolean

Whether the multi factor authentication is enabled or not.

rememberLastUsedMethodboolean

Remembers the last used method.

sessionPreLaunchSessionPrelaunch (object)

Sessions Prelaunch Policy

enabledboolean

Whether the Session Prelaunch is enabled or not

preLaunchModeSessionMode (enum)

Session Mode Type.

0 = Off,1 = Basic,2 = MachineLearning

preLaunchExcludenullable array of string

The values of the session pre launch.

itemsstring

localProxyAddressLocalProxyAddress (object)

Local Proxy Address Policy

enabledboolean

Whether the local proxy address is enabled or not

useLocalHostProxyIPboolean

If the box is checked the 127.0.0.1 IP address is used when using Gateway mode in VPN scenarios

settingsSettings (object)

Sessions Display Settings Policy

enabledboolean

Whether Display Settings is enabled or not.

colorDepthsSettingsColorDepth (enum)

Settings Color Depth Type.

0 = Colors256,1 = HighColor15Bit,2 = HighColor16Bit,3 = TrueColor24Bit,4 = HighestQuality32Bit

graphicsAccelerationAccelerationMode (enum)

Acceleration Mode Type.

0 = None,1 = Basic,2 = RemoteFx,3 = RemoteFxAdaptive,4 = AVCAdaptive

multiMonitorMultiMonitor (object)

Sessions Multi-Monitor Policy

enabledboolean

Whether the Multi-Monitor policy is enabled or not.

useAllMonitorsboolean

If set to true, the session will use all available monitors if applicable (deprecated).

displayConfigDisplayConfig (enum)

Display configuration Type.

0 = Primary,1 = All,2 = Selected

publishedApplicationsPublishedApplications (object)

Sessions Published Applications Policy

enabledboolean

Whether the Published Applications policy is enabled or not.

usePrimaryMonitorboolean

If set to true, will use the primary monitor only.

useDynamicDesktopResizingboolean

If set to true, will use dynamic desktop resizing.

desktopOptionsDesktopOptions (object)

Sessions Desktop Options Policy

enabledboolean

Whether Display Settings Options is enabled or not

smartSizingSmartSizing (enum)

Smart Sizing Type.

0 = Disabled,1 = Scale,2 = Resize

embedDesktopboolean

If box is checked the desktop will always be fixed

spanDesktopsboolean

If box is checked the desktop will spanned across all other monitors

fullScreenBarConnectionBar (enum)

Connection Bar Type.

0 = DoNotShow,1 = ShowPinned,2 = ShowUnPinned

browserBrowser (object)

Sessions Browser Policy

enabledboolean

Whether Display Settings Browser is enabled or not

browserOpenInOpenApplicationsIn (enum)

Open Applications In Type.

0 = SameTab,1 = NewTab

printingSessionsPrinting (object)

Sessions Printing Policy

enabledboolean

Whether Printing Policy is enabled or not

redirectPrinterTechPrintingTechnologyUse (enum)

Printing Technology Use Type.

0 = None,1 = RasUniversalPrintingTechnology,2 = MicrosoftBasicPrintingTechnology,3 = RasUniversalPrintingAndMsBasicTechnologies

redirectPrintersUniversalPrinting (enum)

Universal Printing Type.

0 = All,1 = DefaultOnly,2 = SpecificOnly

redirectPrintersListnullable array of string

List of names of printers that are used to redirect to

itemsstring

printingOptionsPrintingOptions (object)

Printing Options

dataFormatPrintingDataFormat (enum)

Printing Data Format.

0 = ViewPDF_ExtApp,1 = EMF,2 = BMP,4 = PrintPDF_ExtApp,5 = PrintPDF

printerPreferenceClientPrinterPreference (enum)

Client Printer Preference.

0 = ServerPrefAllPrinters,1 = ClientPrefAllPrinters,2 = ClientPrefSpecificPrinters

specificPreferredPrinternullable string

The Specific Preferred Printer.

defaultPrintingSettingsDefaultPrintingSettings (object)

Default Printing Settings

defaultPrinterTechPrintingTechnologyUse (enum)

Printing Technology Use Type.

0 = None,1 = RasUniversalPrintingTechnology,2 = MicrosoftBasicPrintingTechnology,3 = RasUniversalPrintingAndMsBasicTechnologies

forceTimeinteger (int32)

Force Default Printer for Seconds.

matchExactPrinterNameboolean

Match Exact Printer Name.

updateRemoteDefPrinterboolean

Update the remote default printer.

scanningScanning (object)

Sessions Scanning Policy

enabledboolean

Whether Scanning policy is enabled or not

scanTechScanningTechnologyUse (enum)

Scanning Technology Use Type.

0 = None,1 = WIA,2 = TWAIN,3 = WIAandTWAIN

scanRedirectRedirectScanner (enum)

Redirect Scanner Type.

0 = All,1 = SpecificOnly

scanListTwainnullable array of string

The scanning TWAIN list

itemsstring

scanListWianullable array of string

The scanning WIA list

itemsstring

audioAudio (object)

Sessions Audio Policy

enabledboolean

Whether Audio policy is enabled or not

audioModesAudioMode (enum)

Audio Mode Type.

0 = BringToThisComputer,1 = DoNotPlay,2 = LeaveAtRemoteComputer

audioQualityAudioQuality (enum)

Audio Quality Type.

0 = AdjustDynamically,1 = UseMediumQuality,2 = UseUncompressedQuality

audioRecboolean

Allow Audio Recording if box is ticked.

keyboardKeyboard (object)

Sessions Keyboard Policy

enabledboolean

Whether Keyboard policy is enabled or not

keyboardWindowKeyboardType (enum)

Keyboard Type.

0 = LocalComputer,1 = RemoteComputer,2 = FullScreenMode

sendUnicodeCharsboolean

Allow Unicode characters if the box is checked.

clipboardClipboard (object)

Settings about the Clipboard of the Local Devices

enabledboolean

Whether clipboard policy is enabled or not.

clipboardDirectionClipboardDirections (enum)

Clipboard Direction Type.

0 = None,1 = ClientToServer,2 = ServerToClient,3 = Bidirectional

diskDrivesDiskDrives (object)

Settings about the Disk Drives of the Local Devices

enabledboolean

Whether Disk Drives policy is enabled or not

redirectDrivesboolean

Whether Drives Redirection is enabled or not

dynamicDrivesboolean

Whether Drives that are plugged in later on are dynamically connected or not

redirectToDrivesnullable array of string

The drives to redirect to.

itemsstring

useAllDrivesboolean

Will use all the drives that are available, if set to true

driveCacheModeDriveCacheMode (enum)

Drive Cache Mode

0 = Disable,1 = Enable,2 = Fast

devicesDevices (object)

Settings about the Devices of the Local Devices

enabledboolean

Whether Devices policy is enabled or not

redirectDevicesboolean

If box is checked allow devices redirection

dynamicDevicesboolean

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

useAllDevicesboolean

Use all devices that are available

redirectToDevicesnullable array of string

Redirect to all available devices

itemsstring

portsPorts (object)

Settings about the Ports of the Local Devices

enabledboolean

Whether Ports policy is enabled or not

redirectCOMPortsboolean

If box is checked allow the LPT and COM Redirection

smartCardsSmartCards (object)

Settings about the Smart Cards of the Local Devices

enabledboolean

Whether Smart Card policy is enabled or not

redirectSmartCardsboolean

If box is checked allow the Smart Card Redirection

windowsTouchInputWindowsTouchInput (object)

Settings about the Windows Touch Input of the Local Devices

enabledboolean

Whether Windows Touch Input policy is enabled or not

touchInputboolean

If box is checked allow the window touch redirection.

videoCaptureDevicesVideoCaptureDevices (object)

Settings about the Video Capture Devices

enabledboolean

Whether Devices policy is enabled or not

enableCamerasboolean

If box is checked allow devices redirection

dynamicCamerasboolean

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

videoCaptureUseAllDevicesboolean

Use all devices that are available

camerasIDsnullable array of string

Redirect to all available devices

itemsstring

avdMultimediaRedirectionAVDMultimediaRedirection (object)

Settings about the 'Multimedia Redirection for AVD' (Experimental)

enabledboolean

Whether 'Multimedia Redirection for AVD' policy is enabled or not

avdMultimediaRedirboolean

If box is checked enable Multimedia Redirection for AVD

fileTransferFileTransfer (object)

Settings about the File Transfer of the Local Devices

enabledboolean

Whether File Transfer policy is enabled or not

fileTransferModeFileTransferControlMode (enum)

File Transfer Control modes.

0 = Disabled,1 = ClientToServer,2 = ServerToClient,3 = Bidirectional

performancePerformance (object)

Experience Perfomance Policy

enabledboolean

Whether performance policy is enabled or not

netTypeNetworkType (enum)

Network Type.

0 = Modem,1 = LowSpeedBroadband,2 = Satellite,3 = HighSpeedBroadband,4 = WAN,5 = LAN,6 = DetectConnectionQualityAuto

desktopBackgroundboolean

If the box is checked allow the desktop background

fontSmoothingboolean

If the box is checked allow font smoothing

windowMenuAnimationboolean

If the box is checked allow for the window menu animation

desktopCompositionboolean

If the box is checked allow for the desktop composition

themesboolean

If the box is checked allow for the themes setting

bitmapCachingboolean

If the box is checked allow for bitmap caching.

moveSizeFullDragboolean

Allow the resizing of windows

showContentboolean

Whether show contents of window while dragging is enabled or not

compressionCompression (object)

Experience Compression Policy

enabledboolean

Whether Compression policy is enabled or not

compressboolean

Allow for rdp compression

scanningCompressionCompressionType (enum)

Compression Type.

0 = CompressionDisabled,1 = BestSpeed,2 = BestSize,3 = BasedOnConnectionSpeed

printingCompressionCompressionType (enum)

Compression Type.

0 = CompressionDisabled,1 = BestSpeed,2 = BestSize,3 = BasedOnConnectionSpeed

networkNetwork (object)

Sessions Network Policy

enabledboolean

Whether Network policy is enabled or not

useProxyServerboolean

Check the box if you want to use a proxy server

proxyHostnullable string

The proxy host

proxyPortinteger (int32)

The proxy port

proxyAuthenticationboolean

Check the box if the proxy requires any authentication

proxyUseLogonCredentialsboolean

Will use the user logon credentials

proxyUsernamenullable string

The proxy username authentication

proxyTypeProxyType (enum)

Proxy Type.

0 = SOCKS4,1 = SOCKS4A,2 = SOCKS5,3 = HTTP1_1

advancedSettingsAdvancedSettings (object)

Sessions Advanced Settings Policy

enabledboolean

Whether Advanced Settings policy is enabled or not

useClientColorsboolean

Make use of the system client colours

useClientSettingsboolean

Make use of the system client settings

createShrtCutboolean

Creates the shortcuts on the configured server

registerExtboolean

urlRedirectionboolean

Will redirect url to the client device

mailRedirectionboolean

Will redirect the mail to the client devices

credAlwaysAskboolean

Will always ask for the credentials

allowSrvCmdboolean

Will allow server commands to be executed by the client

promptSrvCmdboolean

Will confirm the server commands before executing them

credSSPboolean

Will allow for network level authentication

redirPOSboolean

Will redirect pos devices

pre2000Credboolean

Will use pre windows 2000 format

disableRUDPboolean

Will disable rdp-udp gateway connections

doNotShowDriveRedirectionDlgboolean

Does not show the redirection drive dialog

serverAuthenticationServerAuthentication (object)

Sessions Server Authentication Policy

enabledboolean

Whether Server Authentication policy is enabled or not

sessionAuthFailureActionIfAuthenticationFail (enum)

If Authentication Fail Type.

0 = Connect,1 = DoNotConnect,2 = Warn

clientOptionsClientOptions (object)

Client Options Policy

enabledboolean

Whether Client Options policy is enabled or not

appearanceAppearance (object)

Client Options Appearance Policy

enabledboolean

Whether Client Options Appearance policy is enabled or not.

uiTypeUIType (enum)

UI Type.

0 = Modern,1 = Classic,2 = User

promptSwitchToModernboolean

Will prompt user to switch to modern UI.

connectionConnection (object)

Client Options Connection Policy

enabledboolean

Whether Client Options Connection policy is enabled or not.

connectionBannerTypeConnectionBannerType (enum)

Connection Banner Type.

0 = SplashWindow,1 = TaskBarToastWindow,2 = None

autoRefreshFarmsboolean

Will automatically refresh the farm every given minutes.

autoRefreshTime_Minsinteger (int32)

The given minutes to refresh the farm.

whenAllSessionClosedActionWhenAllSessionClosedAction (enum)

When All Session Closed Action.

0 = Nothing,1 = LockWorkstation,2 = LogOff

loggingLogging (object)

Client Options Logging Policy

enabledboolean

Whether Advanced Logging policy is enabled or not.

logLevelLogLevelsType (enum)

Log Levels Type.

3 = Standard,4 = Extended,5 = Verbose

loggingStartDateTimestring (date-time)

Logging Start DateTime.

loggingDurationinteger (int32)

Logging Duration (in seconds).

allowViewLogboolean

Whether Allow View Log is enabled or not.

allowClearLogboolean

Whether Allow Clear Log is enabled or not.

pcKeyboardPCKeyboard (object)

Client Options PC Keyboard Policy

enabledboolean

Whether Client Options PCKeyboard policy is enabled or not.

forcePCKeybdboolean

Will force to use the pc keyboard if applicable.

pcKeybdKeyboardLayout (enum)

Keyboard Layout.

updateUpdate (object)

Client Options Update Policy

enabledboolean

Whether Client Options Update policy is enabled or not.

checkForUpdateOnLaunchboolean

Will check updates on startup.

updateClientXmlUrlnullable string

The url to update the client.

singleSignOnSingleSignOn (object)

Client Options Single Sign-On Policy

enabledboolean

Whether Client Options SSO policy is enabled or not.

forceThirdPartySSOboolean

Will wrap third party SSO Component.

ssoProvGUIDnullable string

The third party credientials.

advancedClientOptionsAdvancedSettings (object)

Client Options Advanced Policy

enabledboolean

Whether Advanced policy is enabled or not

globalGlobalPolicy (object)

Client Options Global Policy

enabledboolean

Whether Advanced Global policy is enabled or not

showFoldersboolean

Show the connection trees

minimizeToTrayOnCloseboolean

Minimize to tray on close or escape

graphicsAccelboolean

Enable the graphics acceleration for the chrome client

clientWorkAreaBackgroundboolean

Enable the work area background for the chrome client

sslNoWarningboolean

Do not warn if the server certificate is not verified

swapMouseboolean

Swap the mouse buttons

dpiAwareboolean

Enable the dpi aware

autoAddFarmboolean

Add the RAS Connections automatically when starting web or shortcut items

dontPromptAutoAddFarmboolean

No messages are prompted when auto adding ras connections

suppErrMsgsboolean

Close any errors automatically

clearCookiesboolean

Clear session cookies on exit.

turnOffUDPOnClientboolean

Turn off UDP on Client.

languageLanguages (object)

Client Options Languages Policy

enabledboolean

Whether Language policy is enabled or not

langLanguageType (enum)

Languages Type.

0 = Default,1 = English,2 = German,3 = Japanese,5 = French,6 = Spanish,7 = Italian,8 = Portuguese,9 = ChineseSimplified,10 = ChineseTraditional,11 = Korean,12 = Dutch

printingClientOptionsPrinting (object)

Client Options Printing Policy

enabledboolean

Whether Printing policy is enabled or not.

printInstallFontsboolean

Will install any missing fonts automatically.

printRawSupportboolean

Will allow for raw printing support.

allowEMFRasterizationboolean

Will convert non distributable fonts data to images.

printUseCacheboolean

Will cache printer hardware information.

printRefreshCacheboolean

Will refresh printer hardware information every 30 days.

printUseFontsCacheboolean

Will allow for the RAS universal printing embedded fonts.

windowsClientWindowsClient (object)

Client Options Windows Client Policy

enabledboolean

Whether Windows Client policy is enabled or not.

autohideboolean

Will hide the launcher when an application is opened.

autoLaunchboolean

Will launch automatically at windows startup.

remoteFxUsbRedirectionRemoteFxUsbRedirection (object)

Client Options Remote FX USB Redirection Policy

enabledboolean

Whether Remote FX USB Redirection policy is enabled or not.

remoteFXUSBRedirboolean

Will allow redirection of other supported remoted FX USB devices.

customerExperienceProgramCustomerExperienceProgram (object)

Client Options Advanced Customer Experience Program Policy

enabledboolean

Whether Customer Experience Program policy is enabled or not

participateInCEPboolean

Whether to Participate in Customer Experience Program or not

controlSettingsControlSettings (object)

Control Settings Policy

controlSettingsConnectionsConnections (object)

Control Settings Connections Policy

enabledboolean

Whether Control Settings Connections policy is enabled or not.

dontAddNewASXGConnsboolean

Will not be able to add a new ras connections.

dontAddNewStdConnsboolean

Will not be able to add a new rdp connections.

credentialsCredentials (object)

Control Settings Credentials Policy

enabledboolean

Whether Control Settings Credentials policy is enabled or not.

dontSaveUsernameboolean

Will not be able to save the username.

dontSavePwdsboolean

Will not be able to save the password.

dontChangePwdsboolean

Will not be able to change the password.

importExportImportExport (object)

Control Settings Import Export Policy

enabledboolean

Whether Control Settings Import Export policy is enabled or not.

dontImportExportboolean

Will not allow any importation or exportation of the connection settings.

dontImportboolean

Will not allow any importation of the connection settings.

dontExportboolean

Will not allow any exportation of the connection settings.

versioninteger (int32)

Version.

assignmentClientPolicyAssignment (object)

The Client Policy Assignment object.

rulesnullable array of ClientPolicyRule (object)

idinteger (int32)

ID of the object.

priorityinteger (int32)

Priority of the object.

enabledboolean

Whether the Rule is enabled or not

namenullable string

Name of the Rule

descriptionnullable string

Description of the Rule

criteriaClientPolicyCriteria (object)

Client Policy Criteria

securityPrincipalsSecurityPrincipalsCriteria (object)

Security Principals Criteria

enabledboolean

Whether the Security Principals Criteria is enabled or not

matchingModeMatchingModeType (enum)

Matching mode type options

0 = IsNotOneOfTheFollowing,1 = IsOneOfTheFollowing

membersnullable array of SecurityPrincipalCriteriaEntry (object)

User criteria list

accountnullable string

The name of the user/group account the filter is added to.

typeUserType (enum)

User Type

1 = User,2 = Group,3 = ForeignSecurityPrincipal,4 = Computer

sidnullable string

The SID of the user/group account the filter is added to.

gatewaysGatewaysCriteria (object)

Gateways Criteria

enabledboolean

Whether the Gateways Criteria is enabled or not

matchingModeMatchingModeType (enum)

Matching mode type options

0 = IsNotOneOfTheFollowing,1 = IsOneOfTheFollowing

membersnullable array of GatewayCriteriaEntry (object)

Gateway criteria list

gatewayIPnullable string

The gateway IP.

oSsOSsCriteria (object)

OS Criteria Settings

enabledboolean

Whether the OSs Criteria is enabled or not

matchingModeMatchingModeType (enum)

Matching mode type options

0 = IsNotOneOfTheFollowing,1 = IsOneOfTheFollowing

allowedOSesAllowedOperatingSystems (object)

Allowed Operating Systems

chromeboolean

Whether Chrome is allowed or not.

androidboolean

Whether Android is allowed or not.

webClientboolean

Whether Web Client is allowed or not.

iOSboolean

Whether iOS is allowed or not.

linuxboolean

Whether Linux is allowed or not.

macboolean

Whether MAC OS is allowed or not.

wyseboolean

Whether Wyse is allowed or not.

windowsboolean

Whether Windows is allowed or not.

iPsIPsCriteria (object)

IPs Criteria

enabledboolean

Whether the IPs Criteria is enabled or not

matchingModeMatchingModeType (enum)

Matching mode type options

0 = IsNotOneOfTheFollowing,1 = IsOneOfTheFollowing

allowedIPsAllowedIPsCriteria (object)

Allowed IPs Criteria

iPv4snullable array of IPv4CriteriaEntry (object)

IPv4 criteria list

fromnullable string

tonullable string

iPv6snullable array of IPv6CriteriaEntry (object)

IPv6 criteria list

fromnullable string

tonullable string

hardwareIDsHardwareIDsCriteria (object)

Hardware IDs Criteria

enabledboolean

Whether the Hardware IDs Criteria is enabled or not

matchingModeMatchingModeType (enum)

Matching mode type options

0 = IsNotOneOfTheFollowing,1 = IsOneOfTheFollowing

membersnullable array of HardwareIDCriteriaEntry (object)

Hardware IDs criteria list

hardwareIDnullable string

The hardware ID.

accessAccessType (enum)

Access type options

0 = DenyCriteriaWhen,1 = AllowCriteriaWhen

defaultDefaultAssignmentType (enum)

Default assignment type options

0 = Deny,1 = Allow

Request

Response

{
  "adminCreate": "text",
  "adminLastMod": "text",
  "timeCreate": "2024-11-07T10:16:01.718Z",
  "timeLastMod": "2024-11-07T10:16:01.718Z",
  "name": "text",
  "enabled": false,
  "description": "text",
  "usersGroups": [
    {
      "account": "text",
      "type": [
        "1 = User",
        "2 = Group",
        "3 = ForeignSecurityPrincipal",
        "4 = Computer"
      ],
      "sid": "text"
    }
  ],
  "allowedOSes": {
    "chrome": false,
    "android": false,
    "webClient": false,
    "iOS": false,
    "linux": false,
    "mac": false,
    "windows": false
  },
  "gatewayRule": [
    "0 = Any",
    "1 = Connected",
    "2 = NotConnected",
    "3 = NotConnectedToGWs"
  ],
  "gatewayList": [
    "text"
  ],
  "macRule": [
    "0 = AnyMAC",
    "1 = AllowedMACs",
    "2 = NotAllowedMACs"
  ],
  "macList": [
    "text"
  ],
  "clientPolicy": {
    "redirection": {
      "enabled": false,
      "gateway": "text",
      "mode": [
        "0 = GatewayMode",
        "1 = GatewaySSLMode",
        "2 = DirectMode",
        "3 = DirectSSLMode"
      ],
      "altGateway": "text"
    },
    "session": {
      "primaryConnection": {
        "enabled": false,
        "name": "text",
        "autoLogin": false,
        "authenticationType": [
          "0 = Credentials",
          "1 = SingleSignOn",
          "2 = SmartCard",
          "3 = Web"
        ],
        "savePassword": false,
        "domain": "text"
      },
      "secondaryConnections": {
        "enabled": false,
        "connectionList": [
          {
            "mode": [
              "0 = GatewayMode",
              "1 = DirectMode",
              "2 = GatewaySSLMode",
              "3 = DirectSSLMode"
            ],
            "server": "text"
          }
        ]
      },
      "reconnection": {
        "enabled": false,
        "enableReconnection": false
      },
      "computerName": {
        "enabled": false,
        "overrideComputerName": "text"
      },
      "connectionAdvancedSettings": {
        "enabled": false
      },
      "webAuthentication": {
        "enabled": false,
        "defaultOsBrowser": false,
        "openBrowserOnLogout": false
      },
      "multiFactorAuthentication": {
        "enabled": false,
        "rememberLastUsedMethod": false
      },
      "sessionPreLaunch": {
        "enabled": false,
        "preLaunchMode": [
          "0 = Off",
          "1 = Basic",
          "2 = MachineLearning"
        ],
        "preLaunchExclude": [
          "text"
        ]
      },
      "localProxyAddress": {
        "enabled": false,
        "useLocalHostProxyIP": false
      },
      "settings": {
        "enabled": false,
        "colorDepths": [
          "0 = Colors256",
          "1 = HighColor15Bit",
          "2 = HighColor16Bit",
          "3 = TrueColor24Bit",
          "4 = HighestQuality32Bit"
        ],
        "graphicsAcceleration": [
          "0 = None",
          "1 = Basic",
          "2 = RemoteFx",
          "3 = RemoteFxAdaptive",
          "4 = AVCAdaptive"
        ]
      },
      "multiMonitor": {
        "enabled": false,
        "useAllMonitors": false,
        "displayConfig": [
          "0 = Primary",
          "1 = All",
          "2 = Selected"
        ]
      },
      "publishedApplications": {
        "enabled": false,
        "usePrimaryMonitor": false,
        "useDynamicDesktopResizing": false
      },
      "desktopOptions": {
        "enabled": false,
        "smartSizing": [
          "0 = Disabled",
          "1 = Scale",
          "2 = Resize"
        ],
        "embedDesktop": false,
        "spanDesktops": false,
        "fullScreenBar": [
          "0 = DoNotShow",
          "1 = ShowPinned",
          "2 = ShowUnPinned"
        ]
      },
      "browser": {
        "enabled": false,
        "browserOpenIn": [
          "0 = SameTab",
          "1 = NewTab"
        ]
      },
      "printing": {
        "enabled": false,
        "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": {
          "defaultPrinterTech": [
            "0 = None",
            "1 = RasUniversalPrintingTechnology",
            "2 = MicrosoftBasicPrintingTechnology",
            "3 = RasUniversalPrintingAndMsBasicTechnologies"
          ],
          "matchExactPrinterName": false,
          "updateRemoteDefPrinter": false
        }
      },
      "scanning": {
        "enabled": false,
        "scanTech": [
          "0 = None",
          "1 = WIA",
          "2 = TWAIN",
          "3 = WIAandTWAIN"
        ],
        "scanRedirect": [
          "0 = All",
          "1 = SpecificOnly"
        ],
        "scanListTwain": [
          "text"
        ],
        "scanListWia": [
          "text"
        ]
      },
      "audio": {
        "enabled": false,
        "audioModes": [
          "0 = BringToThisComputer",
          "1 = DoNotPlay",
          "2 = LeaveAtRemoteComputer"
        ],
        "audioQuality": [
          "0 = AdjustDynamically",
          "1 = UseMediumQuality",
          "2 = UseUncompressedQuality"
        ],
        "audioRec": false
      },
      "keyboard": {
        "enabled": false,
        "keyboardWindow": [
          "0 = LocalComputer",
          "1 = RemoteComputer",
          "2 = FullScreenMode"
        ],
        "sendUnicodeChars": false
      },
      "clipboard": {
        "enabled": false,
        "clipboardDirection": [
          "0 = None",
          "1 = ClientToServer",
          "2 = ServerToClient",
          "3 = Bidirectional"
        ]
      },
      "diskDrives": {
        "enabled": false,
        "redirectDrives": false,
        "dynamicDrives": false,
        "redirectToDrives": [
          "text"
        ],
        "useAllDrives": false,
        "driveCacheMode": [
          "0 = Disable",
          "1 = Enable",
          "2 = Fast"
        ]
      },
      "devices": {
        "enabled": false,
        "redirectDevices": false,
        "dynamicDevices": false,
        "useAllDevices": false,
        "redirectToDevices": [
          "text"
        ]
      },
      "ports": {
        "enabled": false,
        "redirectCOMPorts": false
      },
      "smartCards": {
        "enabled": false,
        "redirectSmartCards": false
      },
      "windowsTouchInput": {
        "enabled": false,
        "touchInput": false
      },
      "videoCaptureDevices": {
        "enabled": false,
        "enableCameras": false,
        "dynamicCameras": false,
        "videoCaptureUseAllDevices": false,
        "camerasIDs": [
          "text"
        ]
      },
      "avdMultimediaRedirection": {
        "enabled": false,
        "avdMultimediaRedir": false
      },
      "fileTransfer": {
        "enabled": false,
        "fileTransferMode": [
          "0 = Disabled",
          "1 = ClientToServer",
          "2 = ServerToClient",
          "3 = Bidirectional"
        ]
      },
      "performance": {
        "enabled": false,
        "netType": [
          "0 = Modem",
          "1 = LowSpeedBroadband",
          "2 = Satellite",
          "3 = HighSpeedBroadband",
          "4 = WAN",
          "5 = LAN",
          "6 = DetectConnectionQualityAuto"
        ],
        "desktopBackground": false,
        "fontSmoothing": false,
        "windowMenuAnimation": false,
        "desktopComposition": false,
        "themes": false,
        "bitmapCaching": false,
        "moveSizeFullDrag": false,
        "showContent": false
      },
      "compression": {
        "enabled": false,
        "compress": false,
        "scanningCompression": [
          "0 = CompressionDisabled",
          "1 = BestSpeed",
          "2 = BestSize",
          "3 = BasedOnConnectionSpeed"
        ],
        "printingCompression": [
          "0 = CompressionDisabled",
          "1 = BestSpeed",
          "2 = BestSize",
          "3 = BasedOnConnectionSpeed"
        ]
      },
      "network": {
        "enabled": false,
        "useProxyServer": false,
        "proxyHost": "text",
        "proxyAuthentication": false,
        "proxyUseLogonCredentials": false,
        "proxyUsername": "text",
        "proxyType": [
          "0 = SOCKS4",
          "1 = SOCKS4A",
          "2 = SOCKS5",
          "3 = HTTP1_1"
        ]
      },
      "advancedSettings": {
        "enabled": false,
        "useClientColors": false,
        "useClientSettings": false,
        "createShrtCut": false,
        "registerExt": false,
        "urlRedirection": false,
        "mailRedirection": false,
        "credAlwaysAsk": false,
        "allowSrvCmd": false,
        "promptSrvCmd": false,
        "credSSP": false,
        "redirPOS": false,
        "pre2000Cred": false,
        "disableRUDP": false,
        "doNotShowDriveRedirectionDlg": false
      },
      "serverAuthentication": {
        "enabled": false,
        "sessionAuthFailureAction": [
          "0 = Connect",
          "1 = DoNotConnect",
          "2 = Warn"
        ]
      }
    },
    "clientOptions": {
      "enabled": false,
      "appearance": {
        "enabled": false,
        "uiType": [
          "0 = Modern",
          "1 = Classic",
          "2 = User"
        ],
        "promptSwitchToModern": false
      },
      "connection": {
        "enabled": false,
        "connectionBannerType": [
          "0 = SplashWindow",
          "1 = TaskBarToastWindow",
          "2 = None"
        ],
        "autoRefreshFarms": false,
        "whenAllSessionClosedAction": [
          "0 = Nothing",
          "1 = LockWorkstation",
          "2 = LogOff"
        ]
      },
      "logging": {
        "enabled": false,
        "logLevel": [
          "3 = Standard",
          "4 = Extended",
          "5 = Verbose"
        ],
        "loggingStartDateTime": "2024-11-07T10:16:01.718Z",
        "allowViewLog": false,
        "allowClearLog": false
      },
      "pcKeyboard": {
        "enabled": false,
        "forcePCKeybd": false,
        "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": false,
        "checkForUpdateOnLaunch": false,
        "updateClientXmlUrl": "text"
      },
      "singleSignOn": {
        "enabled": false,
        "forceThirdPartySSO": false,
        "ssoProvGUID": "text"
      },
      "advanced": {
        "enabled": false,
        "global": {
          "enabled": false,
          "showFolders": false,
          "minimizeToTrayOnClose": false,
          "graphicsAccel": false,
          "clientWorkAreaBackground": false,
          "sslNoWarning": false,
          "swapMouse": false,
          "dpiAware": false,
          "autoAddFarm": false,
          "dontPromptAutoAddFarm": false,
          "suppErrMsgs": false,
          "clearCookies": false,
          "turnOffUDPOnClient": false
        },
        "language": {
          "enabled": false,
          "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": false,
          "printInstallFonts": false,
          "printRawSupport": false,
          "allowEMFRasterization": false,
          "printUseCache": false,
          "printRefreshCache": false,
          "printUseFontsCache": false
        },
        "windowsClient": {
          "enabled": false,
          "autohide": false,
          "autoLaunch": false
        },
        "remoteFxUsbRedirection": {
          "enabled": false,
          "remoteFXUSBRedir": false
        },
        "customerExperienceProgram": {
          "enabled": false,
          "participateInCEP": false
        }
      }
    },
    "controlSettings": {
      "controlSettingsConnections": {
        "enabled": false,
        "dontAddNewASXGConns": false,
        "dontAddNewStdConns": false
      },
      "credentials": {
        "enabled": false,
        "dontSaveUsername": false,
        "dontSavePwds": false,
        "dontChangePwds": false
      },
      "importExport": {
        "enabled": false,
        "dontImportExport": false,
        "dontImport": false,
        "dontExport": false
      }
    }
  },
  "assignment": {
    "rules": [
      {
        "enabled": false,
        "name": "text",
        "description": "text",
        "criteria": {
          "securityPrincipals": {
            "enabled": false,
            "matchingMode": [
              "0 = IsNotOneOfTheFollowing",
              "1 = IsOneOfTheFollowing"
            ],
            "members": [
              {
                "account": "text",
                "type": [
                  "1 = User",
                  "2 = Group",
                  "3 = ForeignSecurityPrincipal",
                  "4 = Computer"
                ],
                "sid": "text"
              }
            ]
          },
          "gateways": {
            "enabled": false,
            "matchingMode": [
              "0 = IsNotOneOfTheFollowing",
              "1 = IsOneOfTheFollowing"
            ],
            "members": [
              {
                "gatewayIP": "text"
              }
            ]
          },
          "oSs": {
            "enabled": false,
            "matchingMode": [
              "0 = IsNotOneOfTheFollowing",
              "1 = IsOneOfTheFollowing"
            ],
            "allowedOSes": {
              "chrome": false,
              "android": false,
              "webClient": false,
              "iOS": false,
              "linux": false,
              "mac": false,
              "wyse": false,
              "windows": false
            }
          },
          "iPs": {
            "enabled": false,
            "matchingMode": [
              "0 = IsNotOneOfTheFollowing",
              "1 = IsOneOfTheFollowing"
            ],
            "allowedIPs": {
              "iPv4s": [
                {
                  "from": "text",
                  "to": "text"
                }
              ],
              "iPv6s": [
                {
                  "from": "text",
                  "to": "text"
                }
              ]
            }
          },
          "hardwareIDs": {
            "enabled": false,
            "matchingMode": [
              "0 = IsNotOneOfTheFollowing",
              "1 = IsOneOfTheFollowing"
            ],
            "members": [
              {
                "hardwareID": "text"
              }
            ]
          },
          "access": [
            "0 = DenyCriteriaWhen",
            "1 = AllowCriteriaWhen"
          ]
        }
      }
    ],
    "default": [
      "0 = Deny",
      "1 = Allow"
    ]
  }
}