Apache Guacamole Users API

User account management

Operations 5

GET /api/session/data/{dataSource}/users Apache Guacamole List Users #
POST /api/session/data/{dataSource}/users Apache Guacamole Create User #
GET /api/session/data/{dataSource}/users/{username} Apache Guacamole Get User #
PUT /api/session/data/{dataSource}/users/{username} Apache Guacamole Update User #
DELETE /api/session/data/{dataSource}/users/{username} Apache Guacamole Delete User #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/apache-guacamole-users-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

apache-guacamole-users-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Apache Guacamole REST Active Connections Users API
  version: 1.6.0
  description: REST API for managing Apache Guacamole remote desktop gateway including connections, users, user groups, permissions, and active sessions.
  contact:
    email: user@guacamole.apache.org
  license:
    name: Apache 2.0
    url: https://www.apache.org/licenses/LICENSE-2.0
servers:
- url: http://localhost:8080/guacamole
  description: Apache Guacamole Server
tags:
- name: Users
  description: User account management
paths:
  /api/session/data/{dataSource}/users:
    get:
      operationId: listUsers
      summary: Apache Guacamole List Users
      description: List all user accounts in the Guacamole system.
      tags:
      - Users
      parameters:
      - name: dataSource
        in: path
        required: true
        description: The data source identifier
        schema:
          type: string
      - name: Guacamole-Token
        in: header
        required: true
        description: Authentication token
        schema:
          type: string
      responses:
        '200':
          description: Users listed successfully
          content:
            application/json:
              schema:
                type: object
                additionalProperties:
                  $ref: '#/components/schemas/User'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    post:
      operationId: createUser
      summary: Apache Guacamole Create User
      description: Create a new Guacamole user account.
      tags:
      - Users
      parameters:
      - name: dataSource
        in: path
        required: true
        description: The data source identifier
        schema:
          type: string
      - name: Guacamole-Token
        in: header
        required: true
        description: Authentication token
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/User'
      responses:
        '200':
          description: User created successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/User'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /api/session/data/{dataSource}/users/{username}:
    get:
      operationId: getUser
      summary: Apache Guacamole Get User
      description: Get details of a specific Guacamole user account.
      tags:
      - Users
      parameters:
      - name: dataSource
        in: path
        required: true
        description: The data source identifier
        schema:
          type: string
      - name: username
        in: path
        required: true
        description: The username
        schema:
          type: string
          example: guacadmin
      - name: Guacamole-Token
        in: header
        required: true
        description: Authentication token
        schema:
          type: string
      responses:
        '200':
          description: User retrieved successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/User'
        '404':
          description: User not found
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    put:
      operationId: updateUser
      summary: Apache Guacamole Update User
      description: Update a Guacamole user account.
      tags:
      - Users
      parameters:
      - name: dataSource
        in: path
        required: true
        description: The data source identifier
        schema:
          type: string
      - name: username
        in: path
        required: true
        description: The username
        schema:
          type: string
      - name: Guacamole-Token
        in: header
        required: true
        description: Authentication token
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/User'
      responses:
        '204':
          description: User updated successfully
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    delete:
      operationId: deleteUser
      summary: Apache Guacamole Delete User
      description: Delete a Guacamole user account.
      tags:
      - Users
      parameters:
      - name: dataSource
        in: path
        required: true
        description: The data source identifier
        schema:
          type: string
      - name: username
        in: path
        required: true
        description: The username to delete
        schema:
          type: string
      - name: Guacamole-Token
        in: header
        required: true
        description: Authentication token
        schema:
          type: string
      responses:
        '204':
          description: User deleted successfully
        '404':
          description: User not found
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
components:
  schemas:
    User:
      type: object
      description: Guacamole user account
      properties:
        username:
          type: string
          description: Unique username
          example: jsmith
        password:
          type: string
          description: User password (write-only)
          example: securepassword123
        attributes:
          type: object
          description: Additional user attributes
          additionalProperties:
            type: string
        lastActive:
          type: integer
          format: int64
          description: Timestamp of last user activity in milliseconds
          example: 1718153645993
  securitySchemes:
    GuacamoleToken:
      type: apiKey
      in: header
      name: Guacamole-Token
      description: Authentication token obtained from POST /api/tokens