API docs by Redocly

Jump Desktop API (1.0)

Download OpenAPI specification:Download

Jump Desktop Support: support@jumpdesktop.com URL: https://support.jumpdesktop.com Terms of Service

Jump Desktop API

This file describes the Jump Desktop Cloud API. You can use the cloud api to manage your Jump Desktop for Teams account.

OpenAPI 3.0 Specification Download

How to get started

Generate a API Token for your user account by visiting the web dashboard, click Security row on the top left, scroll all the way to the bottom and click the GENERATE NEW TOKEN to generate a new API token. You can then use this API token to call the apis described in this file.

FAQ

How do I get my Team's ID?

Your team’s id can be found in the URL when you visit https://app.jumpdesktop.com and click on your team's name in the left side bar. Your team's id is in the last part of the URL. In the example URL below, the team'd id is: T-01DC001CDDA14H5634420248

Dashboard URL: https://app.jumpdesktop.com/dashboard/teams/**T-01DC001CDDA14H5634420248**

How do I programmatically add a computer to my team?

Create a pre-configured Jump Desktop Connect installer for your team. The URL for the installer will be returned in the "connectDownloads" field. Download and run the installer. Note: Make sure you don't rename the file before installing it. Once the installer runs, it will automatically add the computer to the team.

"connectDownloads": {
    "macpkg": "url",
    "winexe": "url",
    "winmsi": "url"
}

Use the /v1/team/{teamID}/device/{deviceID}/urls endpoint to retrieve urls for the computer. These URLs are stable and won't change.

{
  "askScreenShare": "url",
  "connect": "url",
  "dashboard": "url"
}

How do I get the user id from a user's email?

Each user on a team has an associated user id. A user's id will never change and it is safe to store in your database. To get a user's user id from their email, use the /v1/team/{teamID}/users end point with 'email' query string.

How do I get a computer's device ID from a computer's name?

Every computer connected to the Jump Desktop Cloud gets a unique device id assigned to it. The device id for a computer does not change (unless Jump Desktop Connect's settings are rest on the computer). To search for a computer by name use the /v1/team/{teamID}/devices endpoint with the 'name' query parameter.

Changelog

1.0.4 2025-10-02

  • Documentation updates
  • Added hasMoreEvents and nextOffset fields in /history/devices api

1.0.3 2022-10-24

1.0.2 2021-12-27

  • Fixed endpoint URLs by prefix /v1 to URLs
  • Added documentation categories
  • Add /history/devices endpoints to get combined computer connection history for a team

1.0.1 2021-05-05

  • Added /users and /devices endpoints. Use these endpoints to search for users by email or devices by name.

1.0 2021-05-02

  • Public release

0.3 2021-04-27

  • New: annotation endpoints: Annotations can be used to add user defined keys and values to team resources like users, access groups and computers.
  • BREAKING CHANGE: /team/device/delete/members endpoint has changed to /team/device/members/delete for consistency with other apis.

0.2 2021-04-19

  • New: team/device endpoint to retrieve information about a single device
  • New: device/urls endpoint to get urls used to launch connections to computers

0.1 2021-04-14

  • Initial API release

Teams Billing

Get team billing ledger

Get all team events that affect the billable amount within a time range

Authorizations:
ApiToken
path Parameters
teamid
required
string

Team ID

Responses

Request samples 

curl --request GET \
  --url https://api.jumpdesktop.com/teams/teamid/billing/events \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

Response samples

Content type
application/json
[
  • {
    }
]

Team Information

Get information about a team.

Get team information. Non team admins will see a limited view of team information.

Authorizations:
ApiToken
path Parameters
teamID
required
string

TeamID

Responses

Request samples 

curl --request GET \
  --url https://api.jumpdesktop.com/v1/team/teamID \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

Response samples

Content type
application/json
{
  • "avatarURL": "string",
  • "billing": {
    },
  • "createdAt": {
    },
  • "deleteSchedule": {
    },
  • "deviceConfigs": [
    ],
  • "deviceInvites": [
    ],
  • "devices": {
    },
  • "groups": {
    },
  • "id": "string",
  • "name": "string",
  • "planFeatures": {
    },
  • "saml": {
    },
  • "security": {
    },
  • "userDeviceMigrate": [
    ],
  • "userInvites": [
    ],
  • "users": {
    }
}

Team Computers

Add remote access users to a computer

Add remote access users to a computer

Authorizations:
ApiToken
path Parameters
teamID
required
string

TeamID

Request Body schema: application/json

Body

devices
Array of strings
groups
Array of strings
users
Array of strings

Responses

Request samples

Content type
application/json
{
  • "devices": [
    ],
  • "groups": [
    ],
  • "users": [
    ]
}

Response samples

Content type
application/json
{
  • "devices": [
    ],
  • "errors": [
    ],
  • "users": [
    ]
}

Add remote access users to a computer

Add remote access users to a computer

Authorizations:
ApiToken
path Parameters
teamID
required
string

TeamID

Request Body schema: application/json

Body

devices
Array of strings
groups
Array of strings
users
Array of strings

Responses

Request samples

Content type
application/json
{
  • "devices": [
    ],
  • "groups": [
    ],
  • "users": [
    ]
}

Response samples

Content type
application/json
{
  • "devices": [
    ],
  • "errors": [
    ],
  • "users": [
    ]
}

Get information about a computer

Get information about a computer

Authorizations:
ApiToken
path Parameters
teamID
required
string

TeamID

deviceID
required
string

DeviceID

Responses

Request samples 

curl --request GET \
  --url https://api.jumpdesktop.com/v1/team/teamID/device/deviceID \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

Response samples

Content type
application/json
{
  • "annotations": [
    ],
  • "clientInfo": {
    },
  • "groups": "string",
  • "id": "string",
  • "lastOnlineAt": 0,
  • "name": "string",
  • "users": [
    ]
}

Remove a computer from the team

Remove a computer from the team

Authorizations:
ApiToken
path Parameters
teamID
required
string

TeamID

deviceID
required
string

DeviceID

Responses

Request samples 

curl --request DELETE \
  --url https://api.jumpdesktop.com/v1/team/teamID/device/deviceID \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

Change computer information

Changes computer details

Authorizations:
ApiToken
path Parameters
teamID
required
string

TeamID

deviceID
required
string

DeviceID

Request Body schema: application/json

Body

name
string <= 64 characters

Responses

Request samples

Content type
application/json
{
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string"
}

Get annotations for a computer

Get annotations for a computer

Authorizations:
ApiToken
path Parameters
teamID
required
string

TeamID

deviceID
required
string

DeviceID

Responses

Request samples 

curl --request GET \
  --url https://api.jumpdesktop.com/v1/team/teamID/device/deviceID/annotations \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

Response samples

Content type
application/json
{
  • "annotations": [
    ]
}

Add or update annotations for a computer

Add or update annotations for a computer

Authorizations:
ApiToken
path Parameters
teamID
required
string

TeamID

deviceID
required
string

DeviceID

Request Body schema: application/json

Body

Array of objects (TeamAnnotation)

Responses

Request samples

Content type
application/json
{
  • "annotations": [
    ]
}

Response samples

Content type
application/json
{
  • "annotations": [
    ]
}

Remove annotations for a computer

Remove annotations for a computer.

Authorizations:
ApiToken
path Parameters
teamID
required
string

TeamID

deviceID
required
string

DeviceID

Request Body schema: application/json

Array of annotation keys to remove

annotationKeys
Array of strings

Responses

Request samples

Content type
application/json
{
  • "annotationKeys": [
    ]
}

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

Get computer connection history Deprecated

This API is deprecated. Use /team/{teamID}/history/devices instead.

Gets computer connection history for this device. Returns an empty result if there are no more events for the computer.

Authorizations:
ApiToken
path Parameters
teamID
required
string

TeamID

deviceID
required
string

DeviceID

query Parameters
desc
boolean
Default: false

Set this to true to return events in descending order by time (i.e. latest events first)

limit
integer [ 1 .. 100 ]
Default: 10

Limit the number events returned by the api

offset
integer >= 0
Default: 0

Event offset when returning events

startTime
integer <UnixTimestamp>
Default: 0

Starting time stamp for the query in seconds since unix epoch

stopTime
integer <UnixTimestamp>
Default: 7258118400

Stop time stamp for the query in seconds since unix epoch

Responses

Request samples 

curl --request GET \
  --url 'https://api.jumpdesktop.com/v1/team/teamID/device/deviceID/history?desc=SOME_BOOLEAN_VALUE&limit=SOME_INTEGER_VALUE&offset=SOME_INTEGER_VALUE&startTime=SOME_INTEGER_VALUE&stopTime=SOME_INTEGER_VALUE' \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

Response samples

Content type
application/json
{
  • "events": [
    ]
}

Sets remote access users and groups for a computer

Sets remote access users and groups for a computer. This API will overwrite any groups and users that have remote access to the machine and replace it with the list or users and groups provided.

Authorizations:
ApiToken
path Parameters
teamID
required
string

TeamID

deviceID
required
string

DeviceID

Request Body schema: application/json

Body

groups
Array of strings
users
Array of strings

Responses

Request samples

Content type
application/json
{
  • "groups": [
    ],
  • "users": [
    ]
}

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

Add remote access users to a computer

Add remote access users to a computer

Authorizations:
ApiToken
path Parameters
teamID
required
string

TeamID

deviceID
required
string

DeviceID

Request Body schema: application/json

Body

groups
Array of strings
users
Array of strings

Responses

Request samples

Content type
application/json
{
  • "groups": [
    ],
  • "users": [
    ]
}

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

Remove remote access users from computer

Remove remote access users from computer

Authorizations:
ApiToken
path Parameters
teamID
required
string

TeamID

deviceID
required
string

DeviceID

Request Body schema: application/json

Body

groups
Array of strings
users
Array of strings

Responses

Request samples

Content type
application/json
{
  • "groups": [
    ],
  • "users": [
    ]
}

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

Get URLs used to launch connections to a computer

Get URLs used to launch connections to a computer

Authorizations:
ApiToken
path Parameters
teamID
required
string

TeamID

deviceID
required
string

DeviceID

Responses

Request samples 

curl --request GET \
  --url https://api.jumpdesktop.com/v1/team/teamID/device/deviceID/urls \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

Response samples

Content type
application/json
{
  • "askScreenShare": "string",
  • "connect": "string",
  • "dashboard": "string"
}

Get information about computers on a team

Gets information about computers on a team. Use query parameters to filter results.

Authorizations:
ApiToken
path Parameters
teamID
required
string

TeamID

query Parameters
name
string

Optional. Filter results by computers named 'name'. Use asterisks for a wildcard search: Eg: name* or *name*

Responses

Request samples 

curl --request GET \
  --url 'https://api.jumpdesktop.com/v1/team/teamID/devices?name=SOME_STRING_VALUE' \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

Response samples

Content type
application/json
{
  • "devices": [
    ]
}

Get computer connection history for the team

Gets computer connection history for the team. Use query parameters to search and limit results. Returns an empty result if no events are found.

Authorizations:
ApiToken
path Parameters
teamID
required
string

TeamID

query Parameters
desc
boolean
Default: true

Set this to true to return events in descending order by time (i.e. latest events first)

ids
Array of strings

Set this to limit connection history to specific device / computer ids. Leave this empty for all computers for the team

limit
integer [ 1 .. 1001 ]
Default: 20

Limit the number events returned by the api

offset
integer >= 0
Default: 0

Event offset when returning events

startTime
integer <UnixTimestamp>
Default: 0

Starting time stamp for the query in seconds since unix epoch

stopTime
integer <UnixTimestamp>
Default: 7258118400

Stop time stamp for the query in seconds since unix epoch

Responses

Request samples 

curl --request GET \
  --url 'https://api.jumpdesktop.com/v1/team/teamID/history/devices?desc=SOME_BOOLEAN_VALUE&ids=SOME_ARRAY_VALUE&limit=SOME_INTEGER_VALUE&offset=SOME_INTEGER_VALUE&startTime=SOME_INTEGER_VALUE&stopTime=SOME_INTEGER_VALUE' \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

Response samples

Content type
application/json
{
  • "deviceEvents": [
    ],
  • "hasMoreEvents": true,
  • "nextOffset": 0
}

Create a new Jump Desktop Connect installer

Create a new Jump Desktop Connect installer for the team which can be used to add computers to the team

Authorizations:
ApiToken
path Parameters
teamID
required
string

TeamID

Request Body schema: application/json

Body

expirySecs
integer
groups
Array of strings
name
string [ 0 .. 64 ] characters
requireAuthentication
boolean
singleUse
boolean
users
Array of strings

Responses

Request samples

Content type
application/json
{
  • "expirySecs": 0,
  • "groups": [
    ],
  • "name": "string",
  • "requireAuthentication": true,
  • "singleUse": true,
  • "users": [
    ]
}

Response samples

Content type
application/json
{
  • "connectDownloads": {
    },
  • "createdAt": 0,
  • "deviceConfigID": "",
  • "expiresAt": 0,
  • "groups": [
    ],
  • "id": "string",
  • "name": "string",
  • "requireAuthentication": true,
  • "secret": "string",
  • "users": [
    ]
}

Delete a Jump Desktop Connect installer

Deletes a Jump Desktop installer for the team

Authorizations:
ApiToken
path Parameters
teamID
required
string

TeamID

inviteID
required
string

Device Invite ID

Responses

Request samples 

curl --request DELETE \
  --url https://api.jumpdesktop.com/v1/team/teamID/invite/device/inviteID \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

Team Annotations

Get annotations for a computer

Get annotations for a computer

Authorizations:
ApiToken
path Parameters
teamID
required
string

TeamID

deviceID
required
string

DeviceID

Responses

Request samples 

curl --request GET \
  --url https://api.jumpdesktop.com/v1/team/teamID/device/deviceID/annotations \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

Response samples

Content type
application/json
{
  • "annotations": [
    ]
}

Add or update annotations for a computer

Add or update annotations for a computer

Authorizations:
ApiToken
path Parameters
teamID
required
string

TeamID

deviceID
required
string

DeviceID

Request Body schema: application/json

Body

Array of objects (TeamAnnotation)

Responses

Request samples

Content type
application/json
{
  • "annotations": [
    ]
}

Response samples

Content type
application/json
{
  • "annotations": [
    ]
}

Remove annotations for a computer

Remove annotations for a computer.

Authorizations:
ApiToken
path Parameters
teamID
required
string

TeamID

deviceID
required
string

DeviceID

Request Body schema: application/json

Array of annotation keys to remove

annotationKeys
Array of strings

Responses

Request samples

Content type
application/json
{
  • "annotationKeys": [
    ]
}

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

Get annotations for an access group

Get annotations for an access group

Authorizations:
ApiToken
path Parameters
teamID
required
string

TeamID

groupID
required
string

GroupID

Responses

Request samples 

curl --request GET \
  --url https://api.jumpdesktop.com/v1/team/teamID/group/groupID/annotations \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

Response samples

Content type
application/json
{
  • "annotations": [
    ]
}

Add or update annotations for an access group

Add or update annotations for an access group

Authorizations:
ApiToken
path Parameters
teamID
required
string

TeamID

groupID
required
string

GroupID

Request Body schema: application/json

Body

Array of objects (TeamAnnotation)

Responses

Request samples

Content type
application/json
{
  • "annotations": [
    ]
}

Response samples

Content type
application/json
{
  • "annotations": [
    ]
}

Remove annotations for an access group

Remove annotations for an access group

Authorizations:
ApiToken
path Parameters
teamID
required
string

TeamID

groupID
required
string

GroupID

Request Body schema: application/json

Array of annotation keys to remove

annotationKeys
Array of strings

Responses

Request samples

Content type
application/json
{
  • "annotationKeys": [
    ]
}

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

Get annotations for a user on the team

Get annotations for a user on the team

Authorizations:
ApiToken
path Parameters
teamID
required
string

TeamID

userID
required
string

UserID

Responses

Request samples 

curl --request GET \
  --url https://api.jumpdesktop.com/v1/team/teamID/user/userID/annotations \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

Response samples

Content type
application/json
{
  • "annotations": [
    ]
}

Add or update annotations for a user on the team

Add or update annotations for a user on the team

Authorizations:
ApiToken
path Parameters
teamID
required
string

TeamID

userID
required
string

UserID

Request Body schema: application/json

Body

Array of objects (TeamAnnotation)

Responses

Request samples

Content type
application/json
{
  • "annotations": [
    ]
}

Response samples

Content type
application/json
{
  • "annotations": [
    ]
}

Remove annotations for a user on the team

Remove annotations for a user on the team

Authorizations:
ApiToken
path Parameters
teamID
required
string

TeamID

userID
required
string

UserID

Request Body schema: application/json

Array of annotation keys to remove

annotationKeys
Array of strings

Responses

Request samples

Content type
application/json
{
  • "annotationKeys": [
    ]
}

Response samples

Content type
application/json
{
  • "annotations": [
    ]
}

Team Logs

Get computer connection history Deprecated

This API is deprecated. Use /team/{teamID}/history/devices instead.

Gets computer connection history for this device. Returns an empty result if there are no more events for the computer.

Authorizations:
ApiToken
path Parameters
teamID
required
string

TeamID

deviceID
required
string

DeviceID

query Parameters
desc
boolean
Default: false

Set this to true to return events in descending order by time (i.e. latest events first)

limit
integer [ 1 .. 100 ]
Default: 10

Limit the number events returned by the api

offset
integer >= 0
Default: 0

Event offset when returning events

startTime
integer <UnixTimestamp>
Default: 0

Starting time stamp for the query in seconds since unix epoch

stopTime
integer <UnixTimestamp>
Default: 7258118400

Stop time stamp for the query in seconds since unix epoch

Responses

Request samples 

curl --request GET \
  --url 'https://api.jumpdesktop.com/v1/team/teamID/device/deviceID/history?desc=SOME_BOOLEAN_VALUE&limit=SOME_INTEGER_VALUE&offset=SOME_INTEGER_VALUE&startTime=SOME_INTEGER_VALUE&stopTime=SOME_INTEGER_VALUE' \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

Response samples

Content type
application/json
{
  • "events": [
    ]
}

Get a team's activity history

Get a team's activity history. Returns an empty result if there are no more events left.

Authorizations:
ApiToken
path Parameters
teamID
required
string

TeamID

query Parameters
desc
boolean
Default: true

Set this to false to return events in ascending order by time (i.e. oldest events first)

limit
integer [ 1 .. 1001 ]
Default: 20

Maximum number events to return

offset
integer >= 0
Default: 0

Events offset index

startTime
integer <UnixTimestamp>
Default: 0

The timestamp (in seconds since unix epoch) from where the query starts, including itself.

stopTime
integer <UnixTimestamp>
Default: 7258118400

The timestamp (in seconds since unix epoch) where the query ends, including itself.

Responses

Request samples 

curl --request GET \
  --url 'https://api.jumpdesktop.com/v1/team/teamID/history?desc=SOME_BOOLEAN_VALUE&limit=SOME_INTEGER_VALUE&offset=SOME_INTEGER_VALUE&startTime=SOME_INTEGER_VALUE&stopTime=SOME_INTEGER_VALUE' \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

Response samples

Content type
application/json
{
  • "events": [
    ],
  • "hasMoreEvents": true,
  • "nextOffset": 0
}

Get computer connection history for the team

Gets computer connection history for the team. Use query parameters to search and limit results. Returns an empty result if no events are found.

Authorizations:
ApiToken
path Parameters
teamID
required
string

TeamID

query Parameters
desc
boolean
Default: true

Set this to true to return events in descending order by time (i.e. latest events first)

ids
Array of strings

Set this to limit connection history to specific device / computer ids. Leave this empty for all computers for the team

limit
integer [ 1 .. 1001 ]
Default: 20

Limit the number events returned by the api

offset
integer >= 0
Default: 0

Event offset when returning events

startTime
integer <UnixTimestamp>
Default: 0

Starting time stamp for the query in seconds since unix epoch

stopTime
integer <UnixTimestamp>
Default: 7258118400

Stop time stamp for the query in seconds since unix epoch

Responses

Request samples 

curl --request GET \
  --url 'https://api.jumpdesktop.com/v1/team/teamID/history/devices?desc=SOME_BOOLEAN_VALUE&ids=SOME_ARRAY_VALUE&limit=SOME_INTEGER_VALUE&offset=SOME_INTEGER_VALUE&startTime=SOME_INTEGER_VALUE&stopTime=SOME_INTEGER_VALUE' \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

Response samples

Content type
application/json
{
  • "deviceEvents": [
    ],
  • "hasMoreEvents": true,
  • "nextOffset": 0
}

Team Access Groups

Create a new access group

Create a new access group

Authorizations:
ApiToken
path Parameters
teamID
required
string

TeamID

Request Body schema: application/json

Body

name
required
string [ 1 .. 64 ] characters

Responses

Request samples

Content type
application/json
{
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "annotations": [
    ],
  • "devices": [
    ],
  • "id": "string",
  • "name": "string",
  • "scimManaged": true,
  • "users": [
    ]
}

Add users or computers to a list of access groups

Add users or computers to a list of access groups

Authorizations:
ApiToken
path Parameters
teamID
required
string

TeamID

Request Body schema: application/json

Body

devices
Array of strings
groups
Array of strings
users
Array of strings

Responses

Request samples

Content type
application/json
{
  • "devices": [
    ],
  • "groups": [
    ],
  • "users": [
    ]
}

Response samples

Content type
application/json
{
  • "devices": [
    ],
  • "errors": [
    ],
  • "users": [
    ]
}

Remove users or computers to a list of access groups

Remove users or computers to a list of access groups

Authorizations:
ApiToken
path Parameters
teamID
required
string

TeamID

Request Body schema: application/json

Body

devices
Array of strings
groups
Array of strings
users
Array of strings

Responses

Request samples

Content type
application/json
{
  • "devices": [
    ],
  • "groups": [
    ],
  • "users": [
    ]
}

Response samples

Content type
application/json
{
  • "devices": [
    ],
  • "errors": [
    ],
  • "users": [
    ]
}

Delete an access group

Delete an access group

Authorizations:
ApiToken
path Parameters
teamID
required
string

TeamID

groupID
required
string

GroupID

Responses

Request samples 

curl --request DELETE \
  --url https://api.jumpdesktop.com/v1/team/teamID/group/groupID \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

Change information for an access group

Changes access group information, such as it's name

Authorizations:
ApiToken
path Parameters
teamID
required
string

TeamID

groupID
required
string

GroupID

Request Body schema: application/json

Body

name
string <= 64 characters

Responses

Request samples

Content type
application/json
{
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string"
}

Get annotations for an access group

Get annotations for an access group

Authorizations:
ApiToken
path Parameters
teamID
required
string

TeamID

groupID
required
string

GroupID

Responses

Request samples 

curl --request GET \
  --url https://api.jumpdesktop.com/v1/team/teamID/group/groupID/annotations \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

Response samples

Content type
application/json
{
  • "annotations": [
    ]
}

Add or update annotations for an access group

Add or update annotations for an access group

Authorizations:
ApiToken
path Parameters
teamID
required
string

TeamID

groupID
required
string

GroupID

Request Body schema: application/json

Body

Array of objects (TeamAnnotation)

Responses

Request samples

Content type
application/json
{
  • "annotations": [
    ]
}

Response samples

Content type
application/json
{
  • "annotations": [
    ]
}

Remove annotations for an access group

Remove annotations for an access group

Authorizations:
ApiToken
path Parameters
teamID
required
string

TeamID

groupID
required
string

GroupID

Request Body schema: application/json

Array of annotation keys to remove

annotationKeys
Array of strings

Responses

Request samples

Content type
application/json
{
  • "annotationKeys": [
    ]
}

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

Add users or computers to an access group

Add users or computers to an access group

Authorizations:
ApiToken
path Parameters
teamID
required
string

TeamID

groupID
required
string

GroupID

Request Body schema: application/json

Body

devices
Array of strings
users
Array of strings

Responses

Request samples

Content type
application/json
{
  • "devices": [
    ],
  • "users": [
    ]
}

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

Remove users or computers from an access group

Remove users or computers to an access group

Authorizations:
ApiToken
path Parameters
teamID
required
string

TeamID

groupID
required
string

GroupID

Request Body schema: application/json

Body

devices
Array of strings

List of computer ids to remove from the group

users
Array of strings

List of user ids to remove from the group

Responses

Request samples

Content type
application/json
{
  • "devices": [
    ],
  • "users": [
    ]
}

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

Team Users

Invite users

Create user invites for the team

Authorizations:
ApiToken
path Parameters
teamID
required
string

TeamID

Request Body schema: application/json

Body

devices
Array of strings

List of computer ids the user will automatically have access to once they accept the invite. Empty by default.

groups
Array of strings

List of access group ids the user will automatically be added to once they accept the invite. Empty by default.

name
string [ 0 .. 64 ] characters

The name of the user invite as shown on the web dashboard

sendTo
string

The email address to send the invite to. This can be empty if creating a public invite link

singleUse
boolean

True if this invite is a single use invite. This should be set to true when sending out invites via email

Responses

Request samples

Content type
application/json
{
  • "devices": [
    ],
  • "groups": [
    ],
  • "name": "string",
  • "sendTo": "string",
  • "singleUse": true
}

Response samples

Content type
application/json
{
  • "createdAt": 0,
  • "devices": [
    ],
  • "expiresAt": 0,
  • "groups": [
    ],
  • "name": "string",
  • "secret": "string",
  • "sentTo": "string",
  • "singleUse": true
}

Delete a user invite

Deletes a prior invitation sent to a user on the team

Authorizations:
ApiToken
path Parameters
teamID
required
string

TeamID

secret
required
string

The invite secret

Responses

Request samples 

curl --request DELETE \
  --url https://api.jumpdesktop.com/v1/team/teamID/invite/user/secret \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

Remove a user

Remove a user from the team

Authorizations:
ApiToken
path Parameters
teamID
required
string

TeamID

userID
required
string

UserID

Responses

Request samples 

curl --request DELETE \
  --url https://api.jumpdesktop.com/v1/team/teamID/user/userID \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

Modify a user

Modify a team user

Authorizations:
ApiToken
path Parameters
teamID
required
string

TeamID

userID
required
string

UserID

Request Body schema: application/json

Body

remoteAccess
string
Enum: "enabled" "disabled"
role
string
Enum: "admin" "user"

Responses

Request samples

Content type
application/json
{
  • "remoteAccess": "enabled",
  • "role": "admin"
}

Response samples

Content type
application/json
{
  • "annotations": [
    ],
  • "authProviders": [
    ],
  • "avatarURL": "string",
  • "email": "string",
  • "firstName": "string",
  • "id": "string",
  • "joinedOn": {
    },
  • "lastName": "string",
  • "lastUsedAt": 0,
  • "remoteAccess": "enabled",
  • "role": "admin",
  • "scimUserInfo": {
    },
  • "totpEnabled": true,
  • "userDeviceMigrate": {
    }
}

Get annotations for a user on the team

Get annotations for a user on the team

Authorizations:
ApiToken
path Parameters
teamID
required
string

TeamID

userID
required
string

UserID

Responses

Request samples 

curl --request GET \
  --url https://api.jumpdesktop.com/v1/team/teamID/user/userID/annotations \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

Response samples

Content type
application/json
{
  • "annotations": [
    ]
}

Add or update annotations for a user on the team

Add or update annotations for a user on the team

Authorizations:
ApiToken
path Parameters
teamID
required
string

TeamID

userID
required
string

UserID

Request Body schema: application/json

Body

Array of objects (TeamAnnotation)

Responses

Request samples

Content type
application/json
{
  • "annotations": [
    ]
}

Response samples

Content type
application/json
{
  • "annotations": [
    ]
}

Remove annotations for a user on the team

Remove annotations for a user on the team

Authorizations:
ApiToken
path Parameters
teamID
required
string

TeamID

userID
required
string

UserID

Request Body schema: application/json

Array of annotation keys to remove

annotationKeys
Array of strings

Responses

Request samples

Content type
application/json
{
  • "annotationKeys": [
    ]
}

Response samples

Content type
application/json
{
  • "annotations": [
    ]
}

Send request to user to disable 2FA from the user's account

Sends email to user with a link to disable 2FA from the user's account. The user needs to clicks on the link to disable 2FA. Link is valid for 24 hours only

Authorizations:
ApiToken
path Parameters
teamID
required
string

TeamID

userID
required
string

UserID

Responses

Request samples 

curl --request POST \
  --url https://api.jumpdesktop.com/v1/team/teamID/user/userID/removetotp \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

Get information about users on a team

Gets information about users on a team. Use optional query parameters to filter results.

Authorizations:
ApiToken
path Parameters
teamID
required
string

TeamID

query Parameters
email
string

Optional. Search email address

Responses

Request samples 

curl --request GET \
  --url 'https://api.jumpdesktop.com/v1/team/teamID/users?email=SOME_STRING_VALUE' \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

Response samples

Content type
application/json
{
  • "users": [
    ]
}

Add user to team as long as they are using the same SSO

Add user to team without triggering a confirmation email as long as the user is using the same SSO as the SSO team admin

Authorizations:
ApiToken
path Parameters
teamID
required
string

TeamID

userID
required
string

UserID

Responses

Request samples 

curl --request POST \
  --url https://api.jumpdesktop.com/v1/team/teamID/users/userID \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

Response samples

Content type
application/json
{
  • "avatarURL": "string",
  • "email": "string",
  • "firstName": "string",
  • "id": "string",
  • "lastName": "string",
  • "scimUserInfo": {
    },
  • "userDeviceMigrate": {
    }
}

Get user authentication information

Retrieves authentication-related information for a specific user within a team, such as their TOTP status, authentication providers, and token history. This endpoint does not return detailed user profile data.

Authorizations:
ApiToken
path Parameters
teamid
required
string

Team ID

userid
required
string

User ID

Responses

Request samples 

curl --request GET \
  --url https://api.jumpdesktop.com/v1/team/teamid/user/userid/info \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

Response samples

Content type
application/json
{
  • "authProviders": [
    ],
  • "tokenLog": [
    ],
  • "totp": {
    }
}

SAML Users

List users using team SSO

Get a list of users that use the SSO config of this team to sign in.

Authorizations:
ApiToken
path Parameters
teamid
required
string

TeamID

Responses

Request samples 

curl --request GET \
  --url https://api.jumpdesktop.com/v1/team/teamid/saml/users \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

Response samples

Content type
application/json
[
  • {
    }
]

User Information

Get teams the user is part of

Gets all the team ids the user is part of.

Authorizations:
ApiToken

Responses

Request samples 

curl --request GET \
  --url https://api.jumpdesktop.com/v1/user/teams \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

Response samples

Content type
application/json
[
  • "string"
]