Authenticate with Apache Guacamole
post
/api/device/Remote
Authenticates with Apache Guacamole using encrypted JSON data. If the caller has already authenticated a session with the server, this API will use the username from the session. Otherwise, it will use the Guacamole default user.
Request
There are no request parameters for this operation.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
DeviceID: integer
The device ID to connect to by SSH, VNC or RDP.
-
Password: string
Password required for Username logging into remote device.
-
Port: integer
Uses specific port number (0 - 65535) instead of protocol standard port.
-
Token: string
Uses specific Guacamole token instead of getting from the authenticated session.
-
Type: string
Default Value:
vnc
The type of remote session (SSH, VNC or RDP). -
Username: string
The username for logging into remote device.
Response
Supported Media Types
- application/json
200 Response
Successful operation
Root Schema : schema
Type:
Show Source
object
-
data: object
data
The connection record.
-
message: string
The response message.Example:
Successfully authenticated with Guacamole, and set up connection.
-
success: boolean
Whether the request was successful (true) or not (false).Example:
true
Nested Schema : data
Type:
object
The connection record.
Show Source
-
connectionID: integer
The connection ID.Example:
0
-
directConnectUrl: string
The URL for the UI to redirect to the authenticated remote session.Example:
/go/remote/#/client/MABjAHF1aWNrY29ubmVjdA?token=28E1E03CD50E7BBF748DBD330F53B49ECAEE766F221BCBC18AAE3363C6FD23CD
-
expires: integer
The time when the token expires, in epoch seconds.Example:
1.69538582E12
-
guacHomeUrl: string
The Guacamole home URL.Example:
/go/remote/#/?token=28E1E03CD50E7BBF748DBD330F53B49ECAEE766F221BCBC18AAE3363C6FD23CD
-
token: string
The Guacamole token used for establishing remote session.Example:
28E1E03CD50E7BBF748DBD330F53B49ECAEE766F221BCBC18AAE3363C6FD23CD
Default Response
Failed operation
Root Schema : schema
Type:
Show Source
object
-
errors: array
errors
The list of errors reported. Validation errors will be keyed by record field.
-
message: string
The response message.Example:
Exception thrown
-
success: boolean
Whether the operation was a success (true) or a failure (false).Example:
false
Nested Schema : errors
Type:
array
The list of errors reported. Validation errors will be keyed by record field.
Show Source
Nested Schema : items
Type:
object