/
Getting assigned desktop list

Getting assigned desktop list

Owned by Jorge Olmos (Unlicensed)
Aug 26, 2020

Format

MethodPOST
URL

/vdi/desktop

Request contentDesktopsRequest
Successful answerDesktopsResponse Object
Non-successful answerErrorMessage Object
Unexpected errorHTTP 500

DesktopsRequest Object

Schema

hwaddressStringClient device or browser unique identifier. Must be a chain with 8-50 characters in [ 'a'-'z', 'A'-'Z',, '-', '_', ':']
usernameStringName of the user. Not required is authentication mode is "none".
passwordStringPasswowd of the user. Not required is authentication mode is "none".

JSON example

{
        "hwaddress":"1234-5678",
        "username": "user1",
        "password": "secret"
}

DesktopsResponse Object

Schema

SelectDesktopStatusString

"SelectDesktop": The request was correctly processed, the user is correctly authenticated, and the user is assigned several desktops. message contains an object with desktop data

statusString

Current host state. One of:

"SelectDesktop": The request was correctly processed, the user is correctly authenticated, and the user is assigned several desktops.

"OK": The request was correctly processed, the user is correctly authenticated, and the user is assigned one desktop.

"error": Something did not go well. See message for details.

messageString

If SelectDesktopStatus == "SelectDesktop", message contains a list of desktops.

Else, description of the error.

JSON example

{
    "message": "{'ubuntu16': '1- ubuntu16','centos78':'2- CentOS78', 'winDp':'3- Win 10'}"
    "status": "SelectDesktop"
}

Related content