Apache Guacamole

Apache Guacamole User Groups API

User group management

GitHub OpenAPI

Operations 1

GET /api/session/data/{dataSource}/userGroups Apache Guacamole List User Groups #

Documentation

📖
Documentation
https://guacamole.apache.org/doc/gug/guacamole-rest-api.html

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/apache-guacamole/refs/heads/main/openapi/apache-guacamole-user-groups-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/apache-guacamole/refs/heads/main/json-schema/guacamole-rest-auth-token-schema.json

Other Resources

🔗
JSONLD
https://raw.githubusercontent.com/api-evangelist/apache-guacamole/refs/heads/main/json-ld/apache-guacamole-rest-context.jsonld

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-user-groups-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.

GitHub Google LinkedIn

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

OpenAPI Specification

apache-guacamole-user-groups-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Apache Guacamole REST Active Connections User Groups 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: User Groups
  description: User group management
paths:
  /api/session/data/{dataSource}/userGroups:
    get:
      operationId: listUserGroups
      summary: Apache Guacamole List User Groups
      description: List all user groups in the Guacamole system.
      tags:
      - User Groups
      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: User groups listed successfully
          content:
            application/json:
              schema:
                type: object
                additionalProperties:
                  $ref: '#/components/schemas/UserGroup'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
components:
  schemas:
    UserGroup:
      type: object
      description: Guacamole user group for shared permissions
      properties:
        identifier:
          type: string
          description: Unique group identifier
          example: admins
        attributes:
          type: object
          description: Group attributes
          additionalProperties:
            type: string
  securitySchemes:
    GuacamoleToken:
      type: apiKey
      in: header
      name: Guacamole-Token
      description: Authentication token obtained from POST /api/tokens