Apache Guacamole · JSON Structure

Guacamole Rest Auth Token Structure

Authentication token response from Guacamole login

Type: object Properties: 4
ApacheOpen SourceRDPRemote AccessRemote DesktopSSHVNCWeb Gateway

AuthToken is a JSON Structure definition published by Apache Guacamole, describing 4 properties. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

authToken username dataSource availableDataSources

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/apache-guacamole/refs/heads/main/json-structure/guacamole-rest-auth-token-structure.json",
  "name": "AuthToken",
  "description": "Authentication token response from Guacamole login",
  "type": "object",
  "properties": {
    "authToken": {
      "type": "string",
      "description": "Session authentication token"
    },
    "username": {
      "type": "string",
      "description": "Authenticated username"
    },
    "dataSource": {
      "type": "string",
      "description": "Default data source identifier"
    },
    "availableDataSources": {
      "type": "array",
      "description": "List of available data source identifiers"
    }
  }
}