Documentation Powered by Redocly

Thinfinity Remote Workspace (1.0.0)

Download OpenAPI specification:Download

Overview

This API allows you to administrate Thinfinity Remote Workspace access to resources, labels and brokers.

Authentication

When programming access from web browser, there might be several authentication methods available, as defined in the Thinfinity Remote Workspace Manager, Windows Logon being the default and most common. Subsequent calls will use cookies returned on a successful login call.
You can login using "clientid/clientsecret" mehod and it will return a JWT token to be used in subsequent calls as a in a Authorization header as BEARER authenication.

Error Codes

Thinfinity Remote Workspace uses conventional HTTP response codes to indicate the success or failure of an API request.
All errors response include an error code and an description that briefly explains the error reported.
In general: Codes in the 2xx range indicate success.
Codes in the 4xx range indicate an error that failed given the information provided (e.g., a required parameter was omitted, a charge failed, etc.).
Codes in the 5xx range indicate an error with Thinfinity servers (these are rare). Some 4xx errors that could be handled programmatically (e.g., ............)

Authentication

User authentication

User authentication.

Request Body schema: application/json

The login request object body value depend of the context used.
You can view the authentication methods in the Thinfinity Configuration Manager Authentication section
The main contexts (authentication methods) supported are Windows Logon, Radius, SAML and API Access.


One of
context
required
string

The authentication method defined in the Thinfinity Configuration Manager Authentication section.

username
required
string

The user defined in the Thinfinity Configuration Manager Permissions section

password
required
string

The Windows user password

Responses

Request samples

Content type
application/json
Example
{
  • "context": "Windows Logon",
  • "username": "myUser",
  • "password": "myPassword"
}

Response samples

Content type
application/json
Example
{}

Logout

Logs-out the user and frees the authentication information.

Responses

Changes the user password

It allows you to change the current user password.

Authorizations:
BearerAuthWindowsLogonAndApiAccessAuth
Request Body schema: application/json

Change the user password

password
required
string

The current user password

newpassword
required
string

The new user password

username
required
string

The username defined in then Thinfinity Permissions Manager

Responses

Request samples

Content type
application/json
{
  • "newpassword": "myNewPassword",
  • "password": "myCurrentPassword",
  • "username": "myusername"
}

Response samples

Content type
application/json
{
  • "error": {
    }
}

Profiles

Creates an Access Profile

Creates an access profile.

Authorizations:
BearerAuthWindowsLogonAndApiAccessAuth
Request Body schema: application/json

Profiles Post Request Body.

One of
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Retieves an Access Profile

Retieves an Access Profile item

Authorizations:
BearerAuthWindowsLogonAndApiAccessAuth
path Parameters
publicKey
required
string

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Updates an Access Profile

Updates an Access Profile

Authorizations:
BearerAuthWindowsLogonAndApiAccessAuth
path Parameters
publicKey
required
string
Request Body schema: application/json

Profiles Put Request Body

object (Profile)

Access Profile object

Responses

Request samples

Content type
application/json
{
  • "data": {
    }
}

Response samples

Content type
application/json
{
  • "error": {
    }
}

Deletes an Access Profile

Authorizations:
BearerAuthWindowsLogonAndApiAccessAuth
path Parameters
publicKey
required
string

Responses

Response samples

Content type
application/json
{
  • "error": {
    }
}

Retrieves a list of Access Profiles

Retrieves a list of Access Profiles specifying a filter

Authorizations:
BearerAuthWindowsLogonAndApiAccessAuth
Request Body schema: application/json

Profiles Search Request Body

labelid
string

A Label Id

object

Filter

params
Array of strings

Params

viewAs
string
Enum: "_self" "_all"

Scope

Responses

Request samples

Content type
application/json
{
  • "filter": {
    },
  • "params": [ ],
  • "viewAs": "_all"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Retrieves Access Profile Credentials

Retrieves Access Profile Credentials

Authorizations:
BearerAuthWindowsLogonAndApiAccessAuth
path Parameters
publicKey
required
string

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Update Access Profile Credentials

Updates Access Profile Credentials

Authorizations:
BearerAuthWindowsLogonAndApiAccessAuth
path Parameters
publicKey
required
string
Request Body schema: application/json

Profiles Credentials Put Request Body

object

Responses

Request samples

Content type
application/json
{
  • "workspace": "_pub",
  • "data": {
    }
}

Response samples

Content type
application/json
{
  • "error": {
    }
}

Deletes Access Profile Credentials

Deletes Access Profile Credentials

Authorizations:
BearerAuthWindowsLogonAndApiAccessAuth
path Parameters
publicKey
required
string

Responses

Response samples

Content type
application/json
{
  • "error": {
    }
}

Commits recent changes

Commits changes on Labels and Access Profiles

Authorizations:
BearerAuthWindowsLogonAndApiAccessAuth

Responses

Response samples

Content type
application/json
{
  • "error": {
    }
}

Rollbacks recent changes

Rollbacks changes on Labels and Access Profiles

Authorizations:
BearerAuthWindowsLogonAndApiAccessAuth

Responses

Response samples

Content type
application/json
{
  • "error": {
    }
}

Labels

Commits recent changes

Commits changes on Labels and Access Profiles

Authorizations:
BearerAuthWindowsLogonAndApiAccessAuth

Responses

Response samples

Content type
application/json
{
  • "error": {
    }
}

Rollbacks recent changes

Rollbacks changes on Labels and Access Profiles

Authorizations:
BearerAuthWindowsLogonAndApiAccessAuth

Responses

Response samples

Content type
application/json
{
  • "error": {
    }
}

Creates a Label

Creates a Label. For property descriptions view the Label Schema

Authorizations:
BearerAuthWindowsLogonAndApiAccessAuth
Request Body schema: application/json

Add Label Request Body Object

required
object

Responses

Request samples

Content type
application/json
Example
{
  • "workspace": "_pub",
  • "data": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Retrieves all the labels available to the authenticated user

Retrieves all the labels available to the authenticated user

Authorizations:
BearerAuthWindowsLogonAndApiAccessAuth

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Retrieves a Label.

Retrieves a Label

Authorizations:
BearerAuthWindowsLogonAndApiAccessAuth

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Updates a Label.

Updates a Label. For property descriptions refer to the Label Schema

Authorizations:
BearerAuthWindowsLogonAndApiAccessAuth
path Parameters
labelId
required
string
Example: {A49964B2-CC54-4C52-B7F9-D52EDC37D45}
Request Body schema: application/json

Update Label Request Object

required
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "workspace": "_pub"
}

Response samples

Content type
application/json
{
  • "error": {
    }
}

Deletes a Label

Deletes a Label

Authorizations:
BearerAuthWindowsLogonAndApiAccessAuth
path Parameters
labelId
required
string
Example: {A49964B2-CC54-4C52-B7F9-D52EDC37D45}

Responses

Response samples

Content type
application/json
{
  • "error": {
    }
}

Brokers

Lists the available Brokers

Lists the available Brokers

Authorizations:
BearerAuthWindowsLogonAndApiAccessAuth
cookie Parameters
GWSID
string

GWSID is a required parameter if you use Windows Logon Authentication or if you have more than one broker installed.

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Sets a Broker in Drain Mode

Sets a Brokers in Drain Mode

Authorizations:
BearerAuthWindowsLogonAndApiAccessAuth
cookie Parameters
GWSID
string

GWSID is a required parameter if you use Windows Logon Authentication or if you have more than one broker installed.

Request Body schema: application/json

Drain Mode Request Body Schema

ids
Array of strings

Array of broker ID

value
boolean

Responses

Request samples

Content type
application/json
{
  • "ids": [
    ],
  • "value": true
}

Response samples

Content type
application/json
{
  • "error": {
    }
}