LogoLogo
Download Free TrialLive DemoGet a QuoteContact Us
  • Thinfinity® Workspace
  • About This Document
  • Introduction
  • What's new in Thinfinity® Workspace
  • Architecture
  • Security
  • Getting Started Section
    • Getting Started
    • Installing Thinfinity® Workspace
    • Customizing Thinfinity® Workspace
      • Setting the Access Security Level
        • Access Profiles
          • RDP Profiles
            • Creating an RDP Profile
            • Editing an RDP Profile
            • Disabling an RDP Profile
            • Removing an RDP Profile
            • The "[+]" Profile
          • Web Link Profiles
            • Creating a Web Link Profile
            • Editing a Web Link Profile
            • Disabling a Web Link Profile
            • Removing a Web Link Profile
          • RDS Web Feed Profiles
            • Creating an RDS Web Feed Profile
            • Editing an RDS Web Feed Profile
            • Disabling an RDS Web Feed Profile
            • Removing an RDS Web Feed Profile
          • VNC/RFB Profile
            • Creating a VNC/RFB Profile
            • Editing a VNC/RFB Profile
            • Disabling a VNC/RFB Profile
            • Removing a VNC/RFB Profile
          • Telnet/SSH profile
            • Creating a Telnet/SSH Profile
            • Editing a Telnet/SSH Profile
            • Disabling a Telnet/SSH Profile
            • Removing a Telnet/SSH Profile
      • Testing Internal Access
      • Configuring Internet Access
      • Enabling Remote Sound
      • Mapping Remote Drives
        • Intermediate Disks
        • Shared Folders
    • After Customization
      • Connecting to a Desktop
      • Connecting to an Application
      • Performing a File Transfer
        • Navigating
        • File Options
        • Remote Folder Area Options
        • Downloading and Uploading files
    • Supported RDP Shortcut Keys
    • Using Thinfinity® Workspace for the First Time
      • Verifying the Communication Settings
      • Connecting to a desktop
  • Advanced Settings Section
    • New in Thinfinity® Workspace
      • Web Folder
      • Web VPN
      • Bidirectional Audio Redirection
      • Remote Active Directory
        • How to install and configure Thinfinity® Remote AD Services
        • Active Directory credentials mapping
      • Secondary Broker Pool
        • Architecture
        • How To Install a Secondary Broker
        • How To Add a Pool in the Primary Broker
      • H264 Support
        • How to Enable H264 on your Access Profile
        • Preparing a Remote Desktop for H264 support
      • Web Profile Manager
        • Remote Desktop
        • VNC/RFB
        • Terminal
        • Web Link
        • Web VPN
        • Labels
        • Edit Web Profiles
          • General
          • Display
          • Resources
          • Program
          • Experience
          • Advanced
          • Access Hours
          • Permissions
      • WebBridge - Direct File Transfer
        • How to install Thinfinity® WebBridge
        • WebBridge: User Experience
    • Thinfinity® Configuration Manager
      • General
      • Broker
      • Authentication
        • OAuth/2
          • Methods
          • Settings
          • Mappings
          • Configure OAuth with Okta
          • Configure OAuth with Auth0
        • RADIUS
          • Settings
          • Mappings for SSO
        • TOTP (Time-based One-time Password)
          • TOTP Settings
      • Access Profiles
        • RDP Profile Editor
          • General
            • Setting up a Hyper-V Profile
            • Setting up an RDS Collection Profile
          • Display
          • Resources
          • Program
          • Experience
          • Advanced
          • Printer
          • Permissions
          • Restrictions
          • Access Hours
          • Authentication Methods
        • Web Link Profile Editor
          • General
          • Permissions
          • Restrictions
          • Access Hours
          • Authentication Methods
        • VNC / RFB Profile Editor
          • General
          • Display
          • Permissions
          • Restrictions
          • Access Hours
          • Authentication Methods
        • Telnet/SSH Profile Editor
          • General
          • SSL
          • SSH
          • Display
          • Options
          • Permissions
          • Restrictions
          • Access Hours
          • Authentication Methods
        • Web VPN
          • General
          • Permissions
          • Restrictions
          • Access Hours
          • Authentication Methods
      • Folders
      • Permissions
      • External DLL Authentication Method Settings
      • DUO Authentication Method Settings
        • How to configure DUO
      • SAML Authentication Method Settings
        • Configure SAML with Okta
        • Configure SAML with Centrify
  • Gateway Manager
    • Managing the SSL Certificate
      • The Default Embedded Certificate
      • A Self-Signed Certificate
      • A CA Certificate
  • License Manager
    • License Activation
    • Proxy Activation
    • Get a new Trial Serial Number
    • Activate a Serial Number Online
    • Activate a Serial Number Offline
    • Registering Your License With The License Server Manager
  • Custom Settings
    • Extend the Thinfinity® Workspace Toolbar
  • Customizing the Toolbar
    • Using customsettings.js
    • Using the 'connect' Method
  • Remote FX
  • Save Session
    • Record a Session
    • Play Recorded Sessions
  • Multi-touch Redirection
  • Enhanced Browser and DPI Support
    • Model Inheritance
    • Property Reference
    • The Calculation Process
    • Examples
  • Silent Install Options
  • Credentials Management
    • User-based Access Profiles
    • Credentials Management
  • Customize Translation
  • Mobile Devices Section
    • Mobile Devices
    • Getting into Thinfinity®
    • Mouse Control
    • Keyboards and Toolbars
    • Gestures
    • Disconnecting from Thinfinity®
    • iPad Application
  • Scaling and Load Balancing Section
    • Scaling & Load Balancing
    • Scaling and Load Balancing Configurations
    • Installing Components
    • Configuring a Load Balancing Scenario
    • How to configure your license
  • Integrating Thinfinity® Workspace Section
    • Integrating Thinfinity® Workspace
    • External Authentication
      • Apikey
    • Single sign-on
      • Facebook OAuth Authentication Example
      • Google OAuth/2
        • Google Client ID for Web Applications
      • RADIUS
    • Customizing the Web Interface
      • Changing the Logo
      • Customizing the Web Files
      • Files Location
    • Web Services API
      • Architecture
      • Installing the Web Service
      • Setting up the Communication Settings
      • Profiles Web Service
        • Methods
        • Types
          • The WS Profile type
        • The Demo Applications
      • Analytics Web Service
        • Methods
        • Types
          • WSQueryInfo
          • WSQueryRange
          • WSDBLoginRecord
          • WSSessionRecord
          • WSDBConnectionRecord
          • WSDBBrowserRecord
        • The Demo Application
    • One-Time-URL
      • Configuring the Connection
      • Enabling Features
    • Thinfinity® RemoteAD API reference
    • Thinfinity® REST API Reference
  • User guide Section
    • User Guide
    • Logging In
    • Advanced Web Features
      • Tree View
      • Listing Options
      • Search bar
    • Accessing from Mobile Devices
      • Connecting with Open Parameters
        • General
        • Display
        • Resources
        • Program
        • Experience
        • Advanced
      • Connecting with Profiles
    • Toolbar
      • Actions
      • File Transfer
      • Options
      • Disconnect
    • Features
      • File Transfer
        • Navigating
        • File Options
        • Remote Folder Area Options
        • Downloading and Uploading files
      • Remote Printer
      • Remote Sound
      • Share Session
      • Mapped Drives
      • Analytics
        • Sessions
        • Connections
        • Logins
        • Browsers
        • Filter
        • Configuring MS SQL Server
          • Analytics Tables Reference
    • Disconnecting
Powered by GitBook
On this page
  1. Integrating Thinfinity® Workspace Section
  2. Web Services API
  3. Profiles Web Service
  4. Types

The WS Profile type

The WSProfile type

The complex WSProfile type represents a profile and carries all its information. In order to retrieve, create, delete and update the Thinfinity® Workspace profiles, you will have to manipulate this WSProfile data structure.

Attribute name

Type

Description

Modifiable

ID

string

Profile ID

no

Name

string

Profile name

yes

Enabled

boolean

Set false if you want the profile to be disabled

yes

Unrestricted

boolean

no

GuestAllowed

boolean

Set true to make the profile public

yes

IsBuiltIn

boolean

no

PublicKey

string

Key that identifies a profile .

no

Computer

string

The remote desktop IP and port to connect to

yes

Credentials

Configures the credential mode Thinfinity® Workspace will operate on.

yes

LogonUserName

string

If the credential mode is set to "crAsk", will use this Username to log in into the computer.

yes

LogonPassword

string

If the credential mode is set to "crAsk", will use this Password to log in into the computer.

yes

ScreenResolution

Sets the remote desktop resolution.

yes

ScreenWidth

int

Remote desktop screen width.

yes

ScreenHeight

int

Remote desktop screen height.

yes

BPP

Color Depth: sets the number of bits per pixel

yes

ImageQuality

Remote desktop image quality.

UnicodeKbd

boolean

Allows for full unicode keyboard charsets. Set to false to connect to xRDP servers.

yes

ConsoleSession

boolean

Set to true to connect to the console session. This requires confirmation from the logged on user and will log out the current session.

yes

WebsocketCompression

boolean

Set to true to enable the compression for the exchanged Websocket data and have the application performance improved.

yes

RelativeMouseTouch

boolean

For mobile devices. Uncheck this option to have a mouse behaviour similar to a desktop mouse in which the cursor will always be positioned under the touch. Leave as true to use relative mouse like a trackpad.

yes

AppMode

Application Mode: sets whether the profile should connect to a specific application

yes

AppCmdLine

string

Specify the complete path to give access the application you want to start upon connection.

yes

AppCmdArgs

string

Arguments to start the application informed on the AppCmdLine field.

yes

AppWorkDir

string

Mark this option if you need to specify a context directory for the program set on the field "Program path and file name"

yes

DesktopBackground

boolean

Set to true to show the original remote desktop background.

yes

VisualStyles

boolean

Set to true to change the Start menu and other Windows features styles.

yes

MenuAnimation

boolean

Set to true to show an animation on the Start menu.

yes

FontSmoothing

boolean

Set to true to make text easier to read, especially the magnified text.

yes

ShowWindowOnDrag

boolean

Set to true to show windows content while dragging them.

yes

DesktopComposition

boolean

Set true to configure the DWM to redirected the desktop drawing to off-screen surfaces in video memory. Also, the desktop will present many visual effects.

yes

PrinterEnabled

boolean

Uncheck this option to disable Thinfinity® Workspace PDF printer.

yes

PrinterSetAsDefault

boolean

Mark this option to make Thinfinity® Workspace printer the remote machine default printer.

yes

PrinterName

string

Specify the printer name that you want to be shown on the remote machine's printer list.

yes

PrinterDriver

string

This is the driver to be used by Thinfinity® Workspace in order to print the remote documents.

The "HP Color LaserJet 2800 Series PS" driver is compatible with 2008 Windows versions. The "HP Color LaserJet 8500 PS" driver is compatible with 2003 Windows versions. If you are not using 2003 or 2008 Windows versions, look for a driver that is already installed on the OS and inform this driver name in this attribute.

yes

Clipboard

boolean

Enables and disables the remote desktop clipboard.

yes

DiskEnabled

boolean

yes

DiskName

string

This is the name to identify the intermediate disk among the other remote desktop disks.

yes

DiskAutoDownload

boolean

If set to true, Thinfinity® Workspace will automatically download any file saved/copied in the Intermediate disk direction.

yes

SoundEnabled

boolean

Check this option to enable the remote sound to be reproduced within the browser. The remote sound works only with Firefox and Chrome web browsers.

yes

SoundQuality

Determines what quality Thinfinity® Workspace will use to reproduce the remote sound. The highest the quality, the more resources it will require.

yes

Users

string

Windows Authentication Users or Groups that will be granted access to this profile. Separate each user or group by semicolons.

yes

PreviousTypesNextThe Demo Applications

Last updated 3 years ago

Only the profile has this property set to true. It means that the profile will enable the users to choose the computer they will access entering the IP, port and credentials on the connection moment.

This attribute identifies the profile. Only this profile has this attribute set to true.

Check this option to have an available on the connections created through this profile.

[any computer]
[any computer]
TRdpCredentials
TRdpScreen
Resolution
TRdpScreenBPP
TRdpImageQuality
TRdpAppMode
intermediate disk
TRdpSoundQuality