OTURL Connection Parameters Reference
Besides the basic parameters required to establish a connection, you can send additional parameters to customize the connection the way you want.
Methods 1 and 2 reference an existing Access Profile via the model parameter; Method 3 configures the connection entirely through the query string. OTURL never creates a profile.
Here are the three methods that you can use to customize the OTURL connection:
Use an Access Profile as a Connection Template
| Parameter | What it means | Type/format | Default |
|---|---|---|---|
model |
Input the Profile Key to use the specified profile as a template for the Connection. | stringProfile Key | none |
Use an Access Profile and Override Parameters via Query String
| Parameter | What it means | Type/format | Default |
|---|---|---|---|
overrideDefaults |
Enable this option to override Access Profile settings using query string parameters. Adjust the desired settings for the Access Profile template. If disabled, only the profile’s configured settings will be applied. | booleantrue, false | false |
Use the Query String to Configure Each Parameter Manually
If none of the above methods meets your requirements, you can use the query string to configure each Thinfinity® Workspace setting individually.
Here are the parameters that can be configured:
| Parameter | What it means | Type/format | Default |
|---|---|---|---|
computer |
The remote desktop IP address (or hostname) and port where you want to connect to. Specify this parameter when the authentication mode is None or Username/Password. | stringHost:Port | |
username1 |
The username used to authenticate against the remote machine. If this parameter is not sent, Thinfinity Workspace will prompt the user for this information. See the Note below for details. | stringusername | |
password1 |
The password to authenticate against the remote machine. If this parameter is not sent, Thinfinity Workspace will prompt the user for this information. See the Note below for details. | stringpassword | |
startprg |
To use OTURL for launching specific applications, configure it with one of these values: • 0: “Do nothing” • 1: “Start a program” • 2: “Launch RemoteApp” | integer 0, 1 or 2 | 0 |
command |
Specify the complete path of the remote application to launch once the connection is established. | stringapp path | |
directory |
Initial context directory to be used by the application set on command parameter described above. |
stringdir path | |
cmdargs |
Arguments to start the application specified on the command property. |
stringapp args | |
bpp |
Color Depth: sets the number of bits per pixel: Set 8 for 256 colors; 15 for True Color (15 bit); 16 for True Color (16 bit); 24 for True Color (24 bit) | integer 8, 15, 16 or 24 | 16 |
resolution |
Available options: “fittobrowser”, “fittoscreen”, “fixed”. When set to “fixed”, the width and height parameters will be considered. |
stringtoolbar size | “fittobrowser” |
width |
Remote desktop screen width.It will only be considered when the resolution parameter is set to “fixed”. | integerpixels | Desktop width |
height |
Remote desktop screen height.It will only be considered when the resolution parameter is set to “fixed”. | integerpixels | Desktop height |
imagequality |
Specifies the image quality/compression. Set 0 for “Highest”; 1 for “Optimal”; 2 for “Good”; 3 for “Faster”. | integer 0, 1, 2 or 3 | 1 |
desktopbackground |
Set to true to show the original remote desktop background. | boolean true, false | false |
visualstyles |
Set to true to change the Start menu and other windows features style. | boolean true, false | false |
menuwindowanimation |
Set to true to show an animation on the Start menu. | boolean true, false | false |
fontsmoothing |
Set to true to make text easier to read, especially magnified text. | boolean true, false | false |
showwindowcontent |
Set to true to show windows contents while dragging them. | boolean true, false | false |
desktopcomposition |
Set to true to configure the DWM to redirect the desktop drawing to off-screen surfaces in video memory. The desktop will also present many visual effects. | boolean true, false | false |
unicodekeyboard |
Allows the use of full Unicode keyboard charsets. Set to “false” to connect to xRDP servers. | boolean true, false | true |
keyboardlayout |
Allows specifying the keyboard layout when Unicode keyboard is disabled. | stringKeyboard identifier (hexadecimal) | "00000409 (US) |
console |
Forces the connection to access the remote console session. | boolean true, false | false |
wscompression |
Set to “true” to enable the compression for the exchanged WebSocket data and improve the application performance. | boolean true, false | true |
disablenla |
Configure this parameter if you use a CredSSP other than Microsoft. | boolean true, false | false |
desttype |
Set to “VMID” if you want to establish a connection to a Hyper-V Virtual Machine. Set to “RDS” if you want to create a connection to an RDS Collection VM. If you don’t specify this property or provide a value other than “VMID” or “RDS”, the connection will function as a regular connection. | stringVMID or RDS | |
destinfo |
Enter the Virtual Machine ID for Hyper-V connections, or enter the TSV URL for RDS Collection Virtual Machines. | stringVirtual Machine IDorTSV URL | |
diskenabled |
Set to “true” to have an intermediate disk available on the connection. | boolean true, false | true |
diskname |
Identify the intermediate disk among the other remote desktop disks. | stringname | “ThinDisk” |
diskautodownload |
Set to true to automatically download any file saved/copied in the Intermediate disk. | boolean true, false | true |
Incorporating the username and password within the URL payload configures the Use these credentials authentication option. Omitting either the username or password defaults to the Ask for new credentials selection. The Use the authenticated credentials setting is not supported with One-Time URLs, as such links operate without prior authentication of a valid user on the remote system.
To add each of the parameters to the query string, you have to concatenate an “&” symbol, the name of the parameter, the “=” symbol, and the value assigned to the parameter, as shown in the example below:
...&password=myPassword&model=0mwZVL@aTkRMwc$mj3kUCrzM6@08yse0C7MED3it...