LogoLogo
HomeContact UsRegister for a live demo!Get a Quote
  • Thinfinity Remote Desktop 5
  • About This Document
  • Introduction
  • What's new in 5.0
  • Architecture
  • Security
  • Upgrade from 4.0
  • Getting Started Section
    • Getting Started
    • Installing Thinfinity® Remote Desktop
    • Using Thinfinity® Remote Desktop for the First Time
      • Verifying the Communication Settings
      • Connecting to a desktop
    • Customizing Thinfinity® Remote Desktop
      • 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
          • Weblink Profiles
            • Creating a Weblink Profile
            • Editing a Weblink Profile
            • Disabling a Weblink Profile
            • Removing a Weblink Profile
          • RD Web Access Profiles
            • Creating a RD Web Access Profile
            • Editing a RD Web Access Profile
            • Disabling a RD Web Access Profile
            • Removing a RD Web Access Profile
          • VNC / RFB Profile
            • Creating a VNC Profile
            • Editing a VNC Profile
            • Disabling a VNC Profile
            • Removing a VNC Profile
          • Telnet/SSH profile
            • Creating a Telnet Profile
            • Editing a Telnet Profile
            • Disabling a Telnet Profile
            • Removing a Telnet 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
  • Advanced Settings Section
    • Advanced Settings
    • Thinfinity® Remote Desktop 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
          • Web Link
          • Permissions
        • RD Web Access Editor
          • General
          • Permissions
        • VNC / RFB Profile Editor
          • Display
          • Permissions
          • Restrictions
          • Access Hours
          • Authentication methods
        • Telnet / SSH Profile Editor
          • Display
          • SSL
          • SSH
          • Options
          • Permissions
          • Authentication methods
          • Access Hours
          • Restrictions
      • 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 Remote Desktop’s 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® Remote Desktop
    • Mouse Control
    • Keyboards and Toolbars
    • Gestures
    • Disconnecting from Thinfinity® Remote Desktop
    • iPad Application
      • Configuration
      • Side Bar
  • 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® Remote Desktop Section
    • Integrating Thinfinity® Remote Desktop
    • SDK
      • Deploying
      • Using the SDK
      • SDK Login
      • Connect method
        • Placement
        • Destination and Authentication
        • Settings
          • kbdLayout Values
        • Features
        • Events
        • Toolbar Customization
      • Browser Resizing
      • Keystroke Methods
      • SSL Certificate
      • Demo
    • 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
  • 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

Was this helpful?

Export as PDF
  1. Integrating Thinfinity® Remote Desktop Section
  2. Web Services API
  3. Profiles Web Service

Methods

PreviousProfiles Web ServiceNextTypes

Last updated 4 years ago

Was this helpful?

The main goal of this Web Service is to manipulate the Access Profiles set up. The following methods are available for that purpose. By combining these methods, you will be able to perform pretty much any task regarding the profiles set up.

Method name

Method description

Input params

Output params

Exceptions

GetAllProfiles

Retrieves all the existing profiles.

:

all existing profiles from Thinfinity® Remote Desktop Server

If there are no profiles yet, returns a WSProfileArray with length = 0.

GetProfileCount

Counts how many profiles exist.

integer:

profiles count

GetProfile

Returns a profile located on a determined index.

integer:

profile index

:

profile located on the informed index.

If there is no profile on the indicated index, returns null.

FindByID

Returns the profile that has the indicated ID.

string:

profile ID

:

profile that has the informed ID.

If there is no profile that has the indicated ID, returns null.

FindByComputer

Returns all profiles associated with a computer.

string:

computer IP

:

profiles associated with the informed computer.

If there are no profiles associated with the computer, returns a WSProfileArray with length = 0.

FindByUserName

Returns all profiles assigned to the user.

string:

username

:

user granted profiles.

If there is are no profiles associated with the user, returns a WSProfileArray with length = 0.

CreateProfile

Creates a new profile.

:

profile to be created

:

created profile carrying the new generated ID and public Key.

If the profile could not be created, returns null.

DeleteProfile

Deletes an existing profile.

string:

profile ID

boolean:

returns true if the deletion was successful and false if the application could not delete the profile.

If there is no profile with the indicated ID, returns false.

UpdateProfile

Updates an existing profile.

:

profile to be updated with the new data already loaded in its structure.

int:

returns 0 if the profile was updated successfully. Any value different from 0 means the update could not be performed.

If there is no profile matching the WSProfile ID, returns a value <> 0.

NewPublicKey

Generates a new public key for an existing profile.

string:

profile ID

:

profile carrying the new Public Key.

If there is no profile matching the WSProfile ID, returns null.

Commit

Commits all the performed methods since the last commit or rollback.

Rollback

Rollbacks all the performed methods since the last commit or rollback.

WSProfileArray
WSProfile
WSProfile
WSProfileArray
WSProfileArray
WSProfile
WSProfile
WSProfile
WSProfile