Jump to

• Request
• Response

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

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "DeviceID":{
            "description":"The device ID to connect to by SSH, VNC or RDP.",
            "type":"integer"
        },
        "Type":{
            "description":"The type of remote session (SSH, VNC or RDP).",
            "default":"vnc",
            "type":"string"
        },
        "Port":{
            "description":"Uses specific port number (0 - 65535) instead of protocol standard port.",
            "type":"integer"
        },
        "Token":{
            "description":"Uses specific Guacamole token instead of getting from the authenticated session.",
            "type":"string"
        },
        "Username":{
            "description":"The username for logging into remote device.",
            "type":"string"
        },
        "Password":{
            "description":"Password required for Username logging into remote device.",
            "type":"string"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation

Body ()

Root Schema : schema

Type: object

Show Source

• 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

{
    "type":"object",
    "properties":{
        "success":{
            "description":"Whether the request was successful (<b>true</b>) or not (<b>false</b>).",
            "type":"boolean",
            "example":true
        },
        "message":{
            "description":"The response message.",
            "type":"string",
            "example":"Successfully authenticated with Guacamole, and set up connection."
        },
        "data":{
            "description":"The connection record.",
            "type":"object",
            "properties":{
                "token":{
                    "description":"The Guacamole token used for establishing remote session.",
                    "type":"string",
                    "example":"28E1E03CD50E7BBF748DBD330F53B49ECAEE766F221BCBC18AAE3363C6FD23CD"
                },
                "expires":{
                    "description":"The time when the token expires, in epoch seconds.",
                    "type":"integer",
                    "example":1.69538582E12
                },
                "connectionID":{
                    "description":"The connection ID.",
                    "type":"integer",
                    "example":"0"
                },
                "guacHomeUrl":{
                    "description":"The Guacamole home URL.",
                    "type":"string",
                    "example":"/go/remote/#/?token=28E1E03CD50E7BBF748DBD330F53B49ECAEE766F221BCBC18AAE3363C6FD23CD"
                },
                "directConnectUrl":{
                    "description":"The URL for the UI to redirect to the authenticated remote session.",
                    "type":"string",
                    "example":"/go/remote/#/client/MABjAHF1aWNrY29ubmVjdA?token=28E1E03CD50E7BBF748DBD330F53B49ECAEE766F221BCBC18AAE3363C6FD23CD"
                }
            }
        }
    }
}

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

{
    "description":"The connection record.",
    "type":"object",
    "properties":{
        "token":{
            "description":"The Guacamole token used for establishing remote session.",
            "type":"string",
            "example":"28E1E03CD50E7BBF748DBD330F53B49ECAEE766F221BCBC18AAE3363C6FD23CD"
        },
        "expires":{
            "description":"The time when the token expires, in epoch seconds.",
            "type":"integer",
            "example":1.69538582E12
        },
        "connectionID":{
            "description":"The connection ID.",
            "type":"integer",
            "example":"0"
        },
        "guacHomeUrl":{
            "description":"The Guacamole home URL.",
            "type":"string",
            "example":"/go/remote/#/?token=28E1E03CD50E7BBF748DBD330F53B49ECAEE766F221BCBC18AAE3363C6FD23CD"
        },
        "directConnectUrl":{
            "description":"The URL for the UI to redirect to the authenticated remote session.",
            "type":"string",
            "example":"/go/remote/#/client/MABjAHF1aWNrY29ubmVjdA?token=28E1E03CD50E7BBF748DBD330F53B49ECAEE766F221BCBC18AAE3363C6FD23CD"
        }
    }
}

Default Response

Failed operation

Body ()

Root Schema : schema

Type: object

Show Source

• 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

{
    "properties":{
        "success":{
            "description":"Whether the operation was a success (<b>true</b>) or a failure (<b>false</b>).",
            "type":"boolean",
            "example":"false"
        },
        "message":{
            "description":"The response message.",
            "type":"string",
            "example":"Exception thrown"
        },
        "errors":{
            "description":"The list of errors reported. Validation errors will be keyed by record field.",
            "type":"array",
            "items":{
                "type":"object"
            }
        }
    },
    "type":"object"
}

Nested Schema : errors

Type: array

The list of errors reported. Validation errors will be keyed by record field.

Show Source

• Array of: object items

{
    "description":"The list of errors reported. Validation errors will be keyed by record field.",
    "type":"array",
    "items":{
        "type":"object"
    }
}

Nested Schema : items

Type: object

Back to Top