Repository: ridvanaltun/guacamole-rest-api-documentation
Branch: master
Commit: a593daf9886c
Files: 14
Total size: 85.9 KB
Directory structure:
gitextract_sz567z4i/
├── README.md
└── docs/
├── AUTHENTICATION.md
├── CONNECTION-GROUPS.md
├── CONNECTIONS.md
├── EXTENTIONS.md
├── HISTORY.md
├── LANGUAGES.md
├── PATCHES.md
├── PERMISSIONS.md
├── SCHEMAS.md
├── SHARING-PROFILES.md
├── TUNNELS.md
├── USER-GROUPS.md
└── USERS.md
================================================
FILE CONTENTS
================================================
================================================
FILE: README.md
================================================
<!-- omit in toc -->
# Guacamole Web REST API
Guacamole REST API gives you access and manage Guacamole Web Application.
[](https://god.gw.postman.com/run-collection/8259062-57a268f6-bee4-4cc8-9469-d2214982549f?action=collection%2Ffork&collection-url=entityId%3D8259062-57a268f6-bee4-4cc8-9469-d2214982549f%26entityType%3Dcollection%26workspaceId%3D3ea615b0-b0b9-4991-8aa0-5c1a6b603e99)
<!-- omit in toc -->
## Table of Contents
- [Overview](#overview)
- [Authentication](#authentication)
- [Common Responses](#common-responses)
- [Common Http Request Headers](#common-http-request-headers)
- [Api Ref](#api-ref)
# Overview
This documentation is **unofficial** and based on **Guacamole version 1.1.0**.
Keep in mind, it's not fully tested.
# Authentication
Authentication is required for all requests except the following:
- Authentication
- Languages
- Patches
Token must be named as 'token' and must be placed in request query.
**Example:** `https://localhost/api/session/data/postgresql/connections?token=123456789`
# Common Responses
This section discusses various API responses.
- 200 - A request succeeded.
- 204 - No content
- 400 - Bad request
- 401 - Unauthorized
- 404 - Not found
# Common Http Request Headers
The standard Http request headers that are used in requests.
- Content-Type - The Internet media type of the request body. Used with POST, PUT and PATCH requests. Must be `application/json`.
# Api Ref
- [Authentication](https://github.com/ridvanaltun/guacamole-rest-api-documentation/blob/master/docs/AUTHENTICATION.md)
- [Users](https://github.com/ridvanaltun/guacamole-rest-api-documentation/blob/master/docs/USERS.md)
- [User Groups](https://github.com/ridvanaltun/guacamole-rest-api-documentation/blob/master/docs/USER-GROUPS.md)
- [Connections](https://github.com/ridvanaltun/guacamole-rest-api-documentation/blob/master/docs/CONNECTIONS.md)
- [Connection Groups](https://github.com/ridvanaltun/guacamole-rest-api-documentation/blob/master/docs/CONNECTION-GROUPS.md)
- [Sharing Profiles](https://github.com/ridvanaltun/guacamole-rest-api-documentation/blob/master/docs/SHARING-PROFILES.md)
- [Permissions](https://github.com/ridvanaltun/guacamole-rest-api-documentation/blob/master/docs/PERMISSIONS.md)
- [History](https://github.com/ridvanaltun/guacamole-rest-api-documentation/blob/master/docs/HISTORY.md)
- [Schemas](https://github.com/ridvanaltun/guacamole-rest-api-documentation/blob/master/docs/SCHEMAS.md)
- [Tunnels](https://github.com/ridvanaltun/guacamole-rest-api-documentation/blob/master/docs/TUNNELS.md)
- [Patches](https://github.com/ridvanaltun/guacamole-rest-api-documentation/blob/master/docs/PATCHES.md)
- [Languages](https://github.com/ridvanaltun/guacamole-rest-api-documentation/blob/master/docs/LANGUAGES.md)
================================================
FILE: docs/AUTHENTICATION.md
================================================
<!-- omit in toc -->
# Authentication
Authentication allows you create and delete tokens.
<!-- omit in toc -->
# Table of Contents
- [Generate Token](#generate-token)
- [Headers](#headers)
- [Path Parameters](#path-parameters)
- [Query Parameters](#query-parameters)
- [Request Body](#request-body)
- [Response](#response)
- [Status Code](#status-code)
- [Response Body](#response-body)
- [Response Examples](#response-examples)
- [Delete Token](#delete-token)
- [Headers](#headers-1)
- [Path Parameters](#path-parameters-1)
- [Query Parameters](#query-parameters-1)
- [Request Body](#request-body-1)
- [Response](#response-1)
- [Status Code](#status-code-1)
- [Response Body](#response-body-1)
## Generate Token
Generates token.
<!-- omit in toc -->
### POST /api/tokens
#### Headers
None.
#### Path Parameters
None.
#### Query Parameters
None.
#### Request Body
Body must be `x-www-form-urlencoded`.
- username (string, required) - Name of the user.
- password (string, required) - Password of the user.
```
username: guacadmin
password: guacadmin
```
### Response
#### Status Code
- 200 - OK
#### Response Body
Returns a JSON object.
- authToken (string) - Auth token.
- username (string) - Username.
- dataSource (string) - Datasource.
- availableDatasources (array) - List of available data sources.
#### Response Examples
```json
{
"authToken": "0BDA2CED0580DEB052C34B596AB401993BFD66551FADEF06FC7144F1D6318EE8",
"username": "guacadmin",
"dataSource": "postgresql",
"availableDataSources": ["postgresql", "postgresql-shared"]
}
```
---
## Delete Token
Deletes token.
<!-- omit in toc -->
### DELETE /api/tokens/{{token}}
#### Headers
None.
#### Path Parameters
- token (string, required) - Auth Token
#### Query Parameters
None.
#### Request Body
None.
### Response
#### Status Code
- 204 - No Content
#### Response Body
This request does not return a response body.
---
[Back to Top](#authentication)
================================================
FILE: docs/CONNECTION-GROUPS.md
================================================
<!-- omit in toc -->
# Connection Groups
Manage connection groups.
<!-- omit in toc -->
# Table of Contents
- [List Connection Groups](#list-connection-groups)
- [Headers](#headers)
- [Path Parameters](#path-parameters)
- [Query Parameters](#query-parameters)
- [Request Body](#request-body)
- [Response](#response)
- [Status Code](#status-code)
- [Response Body](#response-body)
- [List Connections and Connection Groups](#list-connections-and-connection-groups)
- [Headers](#headers-1)
- [Path Parameters](#path-parameters-1)
- [Query Parameters](#query-parameters-1)
- [Request Body](#request-body-1)
- [Response](#response-1)
- [Status Code](#status-code-1)
- [Response Body](#response-body-1)
- [Details of Connection Group](#details-of-connection-group)
- [Headers](#headers-2)
- [Path Parameters](#path-parameters-2)
- [Query Parameters](#query-parameters-2)
- [Request Body](#request-body-2)
- [Response](#response-2)
- [Status Code](#status-code-2)
- [Response Body](#response-body-2)
- [Details of Connection Group Tree](#details-of-connection-group-tree)
- [Headers](#headers-3)
- [Path Parameters](#path-parameters-3)
- [Query Parameters](#query-parameters-3)
- [Request Body](#request-body-3)
- [Response](#response-3)
- [Status Code](#status-code-3)
- [Response Body](#response-body-3)
- [Update Connection Group](#update-connection-group)
- [Headers](#headers-4)
- [Path Parameters](#path-parameters-4)
- [Query Parameters](#query-parameters-4)
- [Request Body](#request-body-4)
- [Response](#response-4)
- [Status Code](#status-code-4)
- [Response Body](#response-body-4)
- [Create Connection Group](#create-connection-group)
- [Headers](#headers-5)
- [Path Parameters](#path-parameters-5)
- [Query Parameters](#query-parameters-5)
- [Request Body](#request-body-5)
- [Response](#response-5)
- [Status Code](#status-code-5)
- [Response Body](#response-body-5)
- [Delete Connection Group](#delete-connection-group)
- [Headers](#headers-6)
- [Path Parameters](#path-parameters-6)
- [Query Parameters](#query-parameters-6)
- [Request Body](#request-body-6)
- [Response](#response-6)
- [Status Code](#status-code-6)
- [Response Body](#response-body-6)
## List Connection Groups
List connection groups.
<!-- omit in toc -->
### GET /api/session/data/{{data_source}}/connectionGroups
#### Headers
None.
#### Path Parameters
- data_source (string, required) - Data source
#### Query Parameters
- token (string, required) - Auth Token
#### Request Body
None.
### Response
#### Status Code
- 200 - OK
#### Response Body
**@TODO**
---
## List Connections and Connection Groups
List connection groups with connections.
<!-- omit in toc -->
### GET /api/session/data/{{data_source}}/connectionGroups/ROOT/tree
#### Headers
None.
#### Path Parameters
- data_source (string, required) - Data source
#### Query Parameters
- token (string, required) - Auth Token
#### Request Body
None.
### Response
#### Status Code
- 200 - OK
#### Response Body
**@TODO**
---
## Details of Connection Group
Details of connection group.
<!-- omit in toc -->
### GET /api/session/data/{{data_source}}/connectionGroups/{{connection_group}}
#### Headers
None.
#### Path Parameters
- data_source (string, required) - Data source
- connection_group (integer, required) - Connection group identifier
#### Query Parameters
- token (string, required) - Auth Token
#### Request Body
None.
### Response
#### Status Code
- 200 - OK
#### Response Body
**@TODO**
---
## Details of Connection Group Tree
Details of connection group tree.
<!-- omit in toc -->
### GET /api/session/data/{{data_source}}/connectionGroups/{{connection_group}}/tree
#### Headers
None.
#### Path Parameters
- data_source (string, required) - Data source
- connection_group (integer, required) - Connection group identifier
#### Query Parameters
- token (string, required) - Auth Token
- permission (string, optional) - Permission
#### Request Body
None.
### Response
#### Status Code
- 200 - OK
#### Response Body
**@TODO**
---
## Update Connection Group
Updates connection group.
<!-- omit in toc -->
### PUT /api/session/data/{{data_source}}/connectionGroups/{{connection_group}}
#### Headers
- Content-Type (string, required) - application/json
#### Path Parameters
- data_source (string, required) - Data source
- connection_group (integer, required) - Connection group identifier
#### Query Parameters
- token (string, required) - Auth Token
#### Request Body
**@TODO**
```json
{
"name": "test",
"identifier": "1",
"parentIdentifier": "ROOT",
"type": "ORGANIZATIONAL",
"activeConnections": 0,
"attributes": {
"max-connections": "",
"max-connections-per-user": "",
"enable-session-affinity": ""
}
}
```
### Response
#### Status Code
- 204 - No Content
#### Response Body
This request does not return a response body.
---
## Create Connection Group
Creates connection group.
<!-- omit in toc -->
### POST /api/session/data/{{data_source}}/connectionGroups
#### Headers
- Content-Type (string, required) - application/json
#### Path Parameters
- data_source (string, required) - Data source
#### Query Parameters
- token (string, required) - Auth Token
#### Request Body
**@TODO**
```json
{
"parentIdentifier": "1",
"name": "name",
"type": "ORGANIZATIONAL",
"attributes": {
"max-connections": "",
"max-connections-per-user": "",
"enable-session-affinity": ""
}
}
```
### Response
#### Status Code
- 200 - OK
#### Response Body
**@TODO**
---
## Delete Connection Group
Delete connection group.
<!-- omit in toc -->
### DELETE /api/session/data/{{data_source}}/connectionGroups/{{connection_group}}
#### Headers
None.
#### Path Parameters
- data_source (string, required) - Data source
- connection_group (string, required) - Connection groups identifier
#### Query Parameters
- token (string, required) - Auth token
#### Request Body
None.
### Response
#### Status Code
- 204 - No Content
#### Response Body
This request does not return a response body.
---
[Back to Top](#connection-groups)
================================================
FILE: docs/CONNECTIONS.md
================================================
<!-- omit in toc -->
# Connections
Manage connections.
<!-- omit in toc -->
# Table of Contents
- [List Connections](#list-connections)
- [Headers](#headers)
- [Path Parameters](#path-parameters)
- [Details of Connection](#details-of-connection)
- [Headers](#headers-1)
- [Path Parameters](#path-parameters-1)
- [Query Parameters](#query-parameters)
- [Request Body](#request-body)
- [Response](#response)
- [Status Code](#status-code)
- [Response Body](#response-body)
- [Details of Connection Parameters](#details-of-connection-parameters)
- [Headers](#headers-2)
- [Path Parameters](#path-parameters-2)
- [Query Parameters](#query-parameters-1)
- [Request Body](#request-body-1)
- [Response](#response-1)
- [Status Code](#status-code-1)
- [Response Body](#response-body-1)
- [Details of Connection History](#details-of-connection-history)
- [Headers](#headers-3)
- [Path Parameters](#path-parameters-3)
- [Query Parameters](#query-parameters-2)
- [Request Body](#request-body-2)
- [Response](#response-2)
- [Status Code](#status-code-2)
- [Response Body](#response-body-2)
- [Details of Connection Sharing Profiles](#details-of-connection-sharing-profiles)
- [Headers](#headers-4)
- [Path Parameters](#path-parameters-4)
- [Query Parameters](#query-parameters-3)
- [List Sharing Profiles](#list-sharing-profiles)
- [Headers](#headers-5)
- [Path Parameters](#path-parameters-5)
- [Query Parameters](#query-parameters-4)
- [Request Body](#request-body-3)
- [Response](#response-3)
- [Status Code](#status-code-3)
- [Response Body](#response-body-3)
- [List Active Connections](#list-active-connections)
- [Headers](#headers-6)
- [Path Parameters](#path-parameters-6)
- [Query Parameters](#query-parameters-5)
- [Request Body](#request-body-4)
- [Response](#response-4)
- [Status Code](#status-code-4)
- [Response Body](#response-body-4)
- [Kill Connections](#kill-connections)
- [Headers](#headers-7)
- [Path Parameters](#path-parameters-7)
- [Query Parameters](#query-parameters-6)
- [Request Body](#request-body-5)
- [Response](#response-5)
- [Status Code](#status-code-5)
- [Response Body](#response-body-5)
- [Create VNC Connection](#create-vnc-connection)
- [Headers](#headers-8)
- [Path Parameters](#path-parameters-8)
- [Query Parameters](#query-parameters-7)
- [Request Body](#request-body-6)
- [Response](#response-6)
- [Status Code](#status-code-6)
- [Response Body](#response-body-6)
- [Create SSH Connection](#create-ssh-connection)
- [Headers](#headers-9)
- [Path Parameters](#path-parameters-9)
- [Query Parameters](#query-parameters-8)
- [Request Body](#request-body-7)
- [Response](#response-7)
- [Status Code](#status-code-7)
- [Response Body](#response-body-7)
- [Create RDP Connection](#create-rdp-connection)
- [Headers](#headers-10)
- [Path Parameters](#path-parameters-10)
- [Query Parameters](#query-parameters-9)
- [Request Body](#request-body-8)
- [Response](#response-8)
- [Status Code](#status-code-8)
- [Response Body](#response-body-8)
- [Create Telnet Connection](#create-telnet-connection)
- [Headers](#headers-11)
- [Path Parameters](#path-parameters-11)
- [Query Parameters](#query-parameters-10)
- [Request Body](#request-body-9)
- [Response](#response-9)
- [Status Code](#status-code-9)
- [Response Body](#response-body-9)
- [Create Kubernetes Connection](#create-kubernetes-connection)
- [Headers](#headers-12)
- [Path Parameters](#path-parameters-12)
- [Query Parameters](#query-parameters-11)
- [Request Body](#request-body-10)
- [Response](#response-10)
- [Status Code](#status-code-10)
- [Response Body](#response-body-10)
- [Update VNC Connection](#update-vnc-connection)
- [Headers](#headers-13)
- [Path Parameters](#path-parameters-13)
- [Query Parameters](#query-parameters-12)
- [Request Body](#request-body-11)
- [Response](#response-11)
- [Status Code](#status-code-11)
- [Response Body](#response-body-11)
- [Update SSH Connection](#update-ssh-connection)
- [Headers](#headers-14)
- [Path Parameters](#path-parameters-14)
- [Query Parameters](#query-parameters-13)
- [Request Body](#request-body-12)
- [Response](#response-12)
- [Status Code](#status-code-12)
- [Response Body](#response-body-12)
- [Update RDP Connection](#update-rdp-connection)
- [Headers](#headers-15)
- [Path Parameters](#path-parameters-15)
- [Query Parameters](#query-parameters-14)
- [Request Body](#request-body-13)
- [Response](#response-13)
- [Status Code](#status-code-13)
- [Response Body](#response-body-13)
- [Update Telnet Connection](#update-telnet-connection)
- [Headers](#headers-16)
- [Path Parameters](#path-parameters-16)
- [Query Parameters](#query-parameters-15)
- [Request Body](#request-body-14)
- [Response](#response-14)
- [Status Code](#status-code-14)
- [Response Body](#response-body-14)
- [Update Kubernetes Connection](#update-kubernetes-connection)
- [Headers](#headers-17)
- [Path Parameters](#path-parameters-17)
- [Query Parameters](#query-parameters-16)
- [Request Body](#request-body-15)
- [Response](#response-15)
- [Status Code](#status-code-15)
- [Response Body](#response-body-15)
- [Delete Connection](#delete-connection)
- [Headers](#headers-18)
- [Path Parameters](#path-parameters-18)
- [Query Parameters](#query-parameters-17)
- [Request Body](#request-body-16)
- [Response](#response-16)
- [Status Code](#status-code-16)
- [Response Body](#response-body-16)
## List Connections
List connections.
<!-- omit in toc -->
### GET /api/session/data/{{data_source}}/connections
#### Headers
None.
#### Path Parameters
- data_source (string, required) - Data source
---
## Details of Connection
Details of connection.
<!-- omit in toc -->
### GET /api/session/data/{{data_source}}/connections/{{connection}}
#### Headers
None.
#### Path Parameters
- data_source (string, required) - Data source
- connection (integer, required) - Connection identifier
#### Query Parameters
- token (string, required) - Auth Token
#### Request Body
None.
### Response
#### Status Code
- 200 - OK
#### Response Body
**@TODO**
---
## Details of Connection Parameters
Details of connection parameters.
<!-- omit in toc -->
### GET /api/session/data/{{data_source}}/connections/{{connection}}/parameters
#### Headers
None.
#### Path Parameters
- data_source (string, required) - Data source
- connection (integer, required) - Connection identifier
#### Query Parameters
- token (string, required) - Auth Token
#### Request Body
None.
### Response
#### Status Code
- 200 - OK
#### Response Body
**@TODO**
---
## Details of Connection History
Details of connection history.
<!-- omit in toc -->
### GET /api/session/data/{{data_source}}/connections/{{connection}}/history
#### Headers
None.
#### Path Parameters
- data_source (string, required) - Data source
- connection (integer, required) - Connection identifier
#### Query Parameters
- token (string, required) - Auth Token
#### Request Body
None.
### Response
#### Status Code
- 200 - OK
#### Response Body
**@TODO**
---
## Details of Connection Sharing Profiles
Details of connection sharing profiles.
<!-- omit in toc -->
### GET /api/session/data/{{data_source}}/connections/{{connection}}/sharingProfiles
#### Headers
None.
#### Path Parameters
- data_source (string, required) - Data source
- connection (integer, required) - Connection identifier
#### Query Parameters
- token (string, required) - Auth Token
---
## List Sharing Profiles
List sharing profiles.
<!-- omit in toc -->
### GET /api/session/data/{{data_source}}/sharingProfiles
#### Headers
None.
#### Path Parameters
- data_source (string, required) - Data source
#### Query Parameters
- token (string, required) - Auth Token
#### Request Body
None.
### Response
#### Status Code
- 200 - OK
#### Response Body
**@TODO**
---
## List Active Connections
List active connections.
<!-- omit in toc -->
### GET /api/session/data/{{data_source}}/activeConnections
#### Headers
None.
#### Path Parameters
- data_source (string, required) - Data source
#### Query Parameters
- token (string, required) - Auth Token
#### Request Body
None.
### Response
#### Status Code
- 200 - OK
#### Response Body
**@TODO**
---
## Kill Connections
Kill connections.
<!-- omit in toc -->
### PATCH /api/session/data/{{data_source}}/activeConnections
#### Headers
- Content-Type (string, required) - application/json
#### Path Parameters
- data_source (string, required) - Data source
#### Query Parameters
- token (string, required) - Auth Token
#### Request Body
Body must be [json-patch](http://jsonpatch.com/) format.
```json
[
{
"op": "remove",
"path": "/{{activeConnectionIdentifier}}"
}
]
```
### Response
#### Status Code
- 200 - OK
#### Response Body
**@TODO**
---
## Create VNC Connection
Creates a VNC connection.
<!-- omit in toc -->
### POST /api/session/data/{{data_source}}/connections
#### Headers
- Content-Type (string, required) - application/json
#### Path Parameters
- data_source (string, required) - Data source
#### Query Parameters
- token (string, required) - Auth Token
#### Request Body
**@TODO**
```json
{
"parentIdentifier": "ROOT",
"name": "test",
"protocol": "vnc",
"parameters": {
"port": "",
"read-only": "",
"swap-red-blue": "",
"cursor": "",
"color-depth": "",
"clipboard-encoding": "",
"disable-copy": "",
"disable-paste": "",
"dest-port": "",
"recording-exclude-output": "",
"recording-exclude-mouse": "",
"recording-include-keys": "",
"create-recording-path": "",
"enable-sftp": "true",
"sftp-port": "",
"sftp-server-alive-interval": "",
"enable-audio": "",
"audio-servername": "",
"sftp-directory": "",
"sftp-root-directory": "",
"sftp-passphrase": "",
"sftp-private-key": "",
"sftp-username": "",
"sftp-password": "",
"sftp-host-key": "",
"sftp-hostname": "",
"recording-name": "",
"recording-path": "",
"dest-host": "",
"password": "",
"username": "",
"hostname": ""
},
"attributes": {
"max-connections": "",
"max-connections-per-user": "",
"weight": "",
"failover-only": "",
"guacd-port": "",
"guacd-encryption": "",
"guacd-hostname": ""
}
}
```
### Response
#### Status Code
- 200 - OK
#### Response Body
**@TODO**
---
## Create SSH Connection
Creates a SSH connection.
<!-- omit in toc -->
### POST /api/session/data/{{data_source}}/connections
#### Headers
- Content-Type (string, required) - application/json
#### Path Parameters
- data_source (string, required) - Data source
#### Query Parameters
- token (string, required) - Auth Token
#### Request Body
**@TODO**
```json
{
"parentIdentifier": "ROOT",
"name": "test",
"protocol": "ssh",
"parameters": {
"port": "",
"read-only": "",
"swap-red-blue": "",
"cursor": "",
"color-depth": "",
"clipboard-encoding": "",
"disable-copy": "",
"disable-paste": "",
"dest-port": "",
"recording-exclude-output": "",
"recording-exclude-mouse": "",
"recording-include-keys": "",
"create-recording-path": "",
"enable-sftp": "",
"sftp-port": "",
"sftp-server-alive-interval": "",
"enable-audio": "",
"color-scheme": "",
"font-size": "",
"scrollback": "",
"timezone": null,
"server-alive-interval": "",
"backspace": "",
"terminal-type": "",
"create-typescript-path": "",
"hostname": "",
"host-key": "",
"private-key": "",
"username": "",
"password": "",
"passphrase": "",
"font-name": "",
"command": "",
"locale": "",
"typescript-path": "",
"typescript-name": "",
"recording-path": "",
"recording-name": "",
"sftp-root-directory": ""
},
"attributes": {
"max-connections": "",
"max-connections-per-user": "",
"weight": "",
"failover-only": "",
"guacd-port": "",
"guacd-encryption": "",
"guacd-hostname": ""
}
}
```
### Response
#### Status Code
- 200 - OK
#### Response Body
**@TODO**
---
## Create RDP Connection
Creates a RDP connection.
<!-- omit in toc -->
### POST /api/session/data/{{data_source}}/connections
#### Headers
- Content-Type (string, required) - application/json
#### Path Parameters
- data_source (string, required) - Data source
#### Query Parameters
- token (string, required) - Auth Token
#### Request Body
**@TODO**
```json
{
"parentIdentifier": "ROOT",
"name": "test",
"protocol": "rdp",
"parameters": {
"port": "",
"read-only": "",
"swap-red-blue": "",
"cursor": "",
"color-depth": "",
"clipboard-encoding": "",
"disable-copy": "",
"disable-paste": "",
"dest-port": "",
"recording-exclude-output": "",
"recording-exclude-mouse": "",
"recording-include-keys": "",
"create-recording-path": "",
"enable-sftp": "",
"sftp-port": "",
"sftp-server-alive-interval": "",
"enable-audio": "",
"security": "",
"disable-auth": "",
"ignore-cert": "",
"gateway-port": "",
"server-layout": "",
"timezone": "",
"console": "",
"width": "",
"height": "",
"dpi": "",
"resize-method": "",
"console-audio": "",
"disable-audio": "",
"enable-audio-input": "",
"enable-printing": "",
"enable-drive": "",
"create-drive-path": "",
"enable-wallpaper": "",
"enable-theming": "",
"enable-font-smoothing": "",
"enable-full-window-drag": "",
"enable-desktop-composition": "",
"enable-menu-animations": "",
"disable-bitmap-caching": "",
"disable-offscreen-caching": "",
"disable-glyph-caching": "",
"preconnection-id": "",
"hostname": "",
"username": "",
"password": "",
"domain": "",
"gateway-hostname": "",
"gateway-username": "",
"gateway-password": "",
"gateway-domain": "",
"initial-program": "",
"client-name": "",
"printer-name": "",
"drive-name": "",
"drive-path": "",
"static-channels": "",
"remote-app": "",
"remote-app-dir": "",
"remote-app-args": "",
"preconnection-blob": "",
"load-balance-info": "",
"recording-path": "",
"recording-name": "",
"sftp-hostname": "",
"sftp-host-key": "",
"sftp-username": "",
"sftp-password": "",
"sftp-private-key": "",
"sftp-passphrase": "",
"sftp-root-directory": "",
"sftp-directory": ""
},
"attributes": {
"max-connections": "",
"max-connections-per-user": "",
"weight": "",
"failover-only": "",
"guacd-port": "",
"guacd-encryption": "",
"guacd-hostname": ""
}
}
```
### Response
#### Status Code
- 200 - OK
#### Response Body
**@TODO**
---
## Create Telnet Connection
Creates a Telnet connection.
<!-- omit in toc -->
### POST /api/session/data/{{data_source}}/connections
#### Headers
- Content-Type (string, required) - application/json
#### Path Parameters
- data_source (string, required) - Data source
#### Query Parameters
- token (string, required) - Auth Token
#### Request Body
**@TODO**
```json
{
"parentIdentifier": "ROOT",
"name": "test",
"protocol": "telnet",
"parameters": {
"port": "",
"read-only": "",
"swap-red-blue": "",
"cursor": "",
"color-depth": "",
"clipboard-encoding": "",
"disable-copy": "",
"disable-paste": "",
"dest-port": "",
"recording-exclude-output": "",
"recording-exclude-mouse": "",
"recording-include-keys": "",
"create-recording-path": "",
"enable-sftp": "",
"sftp-port": "",
"sftp-server-alive-interval": "",
"enable-audio": "",
"color-scheme": "",
"font-size": "",
"scrollback": "",
"backspace": "",
"terminal-type": "",
"create-typescript-path": "",
"hostname": "",
"username": "",
"password": "",
"username-regex": "",
"password-regex": "",
"login-success-regex": "",
"login-failure-regex": "",
"font-name": "",
"typescript-path": "",
"typescript-name": "",
"recording-path": "",
"recording-name": ""
},
"attributes": {
"max-connections": "",
"max-connections-per-user": "",
"weight": "",
"failover-only": "",
"guacd-port": "",
"guacd-encryption": "",
"guacd-hostname": ""
}
}
```
### Response
#### Status Code
- 200 - OK
#### Response Body
**@TODO**
---
## Create Kubernetes Connection
Creates a Kubernetes connection.
<!-- omit in toc -->
### POST /api/session/data/{{data_source}}/connections
#### Headers
- Content-Type (string, required) - application/json
#### Path Parameters
- data_source (string, required) - Data source
#### Query Parameters
- token (string, required) - Auth Token
#### Request Body
**@TODO**
```json
{
"parentIdentifier": "ROOT",
"name": "test",
"protocol": "kubernetes",
"parameters": {
"port": "",
"read-only": "",
"swap-red-blue": "",
"cursor": "",
"color-depth": "",
"clipboard-encoding": "",
"disable-copy": "",
"disable-paste": "",
"dest-port": "",
"recording-exclude-output": "",
"recording-exclude-mouse": "",
"recording-include-keys": "",
"create-recording-path": "",
"enable-sftp": "",
"sftp-port": "",
"sftp-server-alive-interval": "",
"enable-audio": "",
"use-ssl": "",
"ignore-cert": "",
"color-scheme": "",
"font-size": "",
"scrollback": "",
"backspace": "",
"create-typescript-path": "",
"hostname": "",
"ca-cert": "",
"namespace": "",
"pod": "",
"container": "",
"client-cert": "",
"client-key": "",
"font-name": "",
"typescript-path": "",
"typescript-name": "",
"recording-path": "",
"recording-name": ""
},
"attributes": {
"max-connections": "",
"max-connections-per-user": "",
"weight": "",
"failover-only": "",
"guacd-port": "",
"guacd-encryption": "",
"guacd-hostname": ""
}
}
```
### Response
#### Status Code
- 200 - OK
#### Response Body
**@TODO**
---
## Update VNC Connection
Updates VNC connection.
<!-- omit in toc -->
### PUT /api/session/data/{{data_source}}/connections/{{connection}}
#### Headers
- Content-Type (string, required) - application/json
#### Path Parameters
- data_source (string, required) - Data source
- connection (integer, required) - Connection identifier
#### Query Parameters
- token (string, required) - Auth Token
#### Request Body
**@TODO**
```json
{
"parentIdentifier": "ROOT",
"name": "test",
"identifier": "1",
"activeConnections": 0,
"protocol": "vnc",
"parameters": {
"port": "",
"read-only": "",
"swap-red-blue": "",
"cursor": "",
"color-depth": "",
"clipboard-encoding": "",
"disable-copy": "",
"disable-paste": "",
"dest-port": "",
"recording-exclude-output": "",
"recording-exclude-mouse": "",
"recording-include-keys": "",
"create-recording-path": "",
"enable-sftp": "true",
"sftp-port": "",
"sftp-server-alive-interval": "",
"enable-audio": "",
"audio-servername": "",
"sftp-directory": "",
"sftp-root-directory": "",
"sftp-passphrase": "",
"sftp-private-key": "",
"sftp-username": "",
"sftp-password": "",
"sftp-host-key": "",
"sftp-hostname": "",
"recording-name": "",
"recording-path": "",
"dest-host": "",
"password": "",
"username": "",
"hostname": ""
},
"attributes": {
"max-connections": "",
"max-connections-per-user": "",
"weight": "",
"failover-only": "",
"guacd-port": "",
"guacd-encryption": "",
"guacd-hostname": ""
}
}
```
### Response
#### Status Code
- 204 - No Content
#### Response Body
This request does not return a response body.
---
## Update SSH Connection
Updates SSH connection.
<!-- omit in toc -->
### PUT /api/session/data/{{data_source}}/connections/{{connection}}
#### Headers
- Content-Type (string, required) - application/json
#### Path Parameters
- data_source (string, required) - Data source
- connection (integer, required) - Connection identifier
#### Query Parameters
- token (string, required) - Auth Token
#### Request Body
**@TODO**
```json
{
"parentIdentifier": "ROOT",
"name": "test",
"identifier": "1",
"activeConnections": 0,
"protocol": "ssh",
"parameters": {
"port": "",
"read-only": "",
"swap-red-blue": "",
"cursor": "",
"color-depth": "",
"clipboard-encoding": "",
"disable-copy": "",
"disable-paste": "",
"dest-port": "",
"recording-exclude-output": "",
"recording-exclude-mouse": "",
"recording-include-keys": "",
"create-recording-path": "",
"enable-sftp": "",
"sftp-port": "",
"sftp-server-alive-interval": "",
"enable-audio": "",
"color-scheme": "",
"font-size": "",
"scrollback": "",
"timezone": null,
"server-alive-interval": "",
"backspace": "",
"terminal-type": "",
"create-typescript-path": "",
"hostname": "",
"host-key": "",
"private-key": "",
"username": "",
"password": "",
"passphrase": "",
"font-name": "",
"command": "",
"locale": "",
"typescript-path": "",
"typescript-name": "",
"recording-path": "",
"recording-name": "",
"sftp-root-directory": ""
},
"attributes": {
"max-connections": "",
"max-connections-per-user": "",
"weight": "",
"failover-only": "",
"guacd-port": "",
"guacd-encryption": "",
"guacd-hostname": ""
}
}
```
### Response
#### Status Code
- 204 - No Content
#### Response Body
This request does not return a response body.
---
## Update RDP Connection
Updates RDP connection.
<!-- omit in toc -->
### PUT /api/session/data/{{data_source}}/connections/{{connection}}
#### Headers
- Content-Type (string, required) - application/json
#### Path Parameters
- data_source (string, required) - Data source
- connection (integer, required) - Connection identifier
#### Query Parameters
- token (string, required) - Auth Token
#### Request Body
**@TODO**
```json
{
"parentIdentifier": "ROOT",
"name": "test",
"identifier": "1",
"activeConnections": 0,
"protocol": "rdp",
"parameters": {
"port": "",
"read-only": "",
"swap-red-blue": "",
"cursor": "",
"color-depth": "",
"clipboard-encoding": "",
"disable-copy": "",
"disable-paste": "",
"dest-port": "",
"recording-exclude-output": "",
"recording-exclude-mouse": "",
"recording-include-keys": "",
"create-recording-path": "",
"enable-sftp": "",
"sftp-port": "",
"sftp-server-alive-interval": "",
"enable-audio": "",
"security": "",
"disable-auth": "",
"ignore-cert": "",
"gateway-port": "",
"server-layout": "",
"timezone": "",
"console": "",
"width": "",
"height": "",
"dpi": "",
"resize-method": "",
"console-audio": "",
"disable-audio": "",
"enable-audio-input": "",
"enable-printing": "",
"enable-drive": "",
"create-drive-path": "",
"enable-wallpaper": "",
"enable-theming": "",
"enable-font-smoothing": "",
"enable-full-window-drag": "",
"enable-desktop-composition": "",
"enable-menu-animations": "",
"disable-bitmap-caching": "",
"disable-offscreen-caching": "",
"disable-glyph-caching": "",
"preconnection-id": "",
"hostname": "",
"username": "",
"password": "",
"domain": "",
"gateway-hostname": "",
"gateway-username": "",
"gateway-password": "",
"gateway-domain": "",
"initial-program": "",
"client-name": "",
"printer-name": "",
"drive-name": "",
"drive-path": "",
"static-channels": "",
"remote-app": "",
"remote-app-dir": "",
"remote-app-args": "",
"preconnection-blob": "",
"load-balance-info": "",
"recording-path": "",
"recording-name": "",
"sftp-hostname": "",
"sftp-host-key": "",
"sftp-username": "",
"sftp-password": "",
"sftp-private-key": "",
"sftp-passphrase": "",
"sftp-root-directory": "",
"sftp-directory": ""
},
"attributes": {
"max-connections": "",
"max-connections-per-user": "",
"weight": "",
"failover-only": "",
"guacd-port": "",
"guacd-encryption": "",
"guacd-hostname": ""
}
}
```
### Response
#### Status Code
- 204 - No Content
#### Response Body
This request does not return a response body.
---
## Update Telnet Connection
Updates Telnet connection.
<!-- omit in toc -->
### PUT /api/session/data/{{data_source}}/connections/{{connection}}
#### Headers
- Content-Type (string, required) - application/json
#### Path Parameters
- data_source (string, required) - Data source
- connection (integer, required) - Connection identifier
#### Query Parameters
- token (string, required) - Auth Token
#### Request Body
**@TODO**
```json
{
"parentIdentifier": "ROOT",
"name": "test",
"identifier": "1",
"activeConnections": 0,
"protocol": "telnet",
"parameters": {
"port": "",
"read-only": "",
"swap-red-blue": "",
"cursor": "",
"color-depth": "",
"clipboard-encoding": "",
"disable-copy": "",
"disable-paste": "",
"dest-port": "",
"recording-exclude-output": "",
"recording-exclude-mouse": "",
"recording-include-keys": "",
"create-recording-path": "",
"enable-sftp": "",
"sftp-port": "",
"sftp-server-alive-interval": "",
"enable-audio": "",
"color-scheme": "",
"font-size": "",
"scrollback": "",
"backspace": "",
"terminal-type": "",
"create-typescript-path": "",
"hostname": "",
"username": "",
"password": "",
"username-regex": "",
"password-regex": "",
"login-success-regex": "",
"login-failure-regex": "",
"font-name": "",
"typescript-path": "",
"typescript-name": "",
"recording-path": "",
"recording-name": ""
},
"attributes": {
"max-connections": "",
"max-connections-per-user": "",
"weight": "",
"failover-only": "",
"guacd-port": "",
"guacd-encryption": "",
"guacd-hostname": ""
}
}
```
### Response
#### Status Code
- 204 - No Content
#### Response Body
This request does not return a response body.
---
## Update Kubernetes Connection
Updates Kubernetes connection.
<!-- omit in toc -->
### PUT /api/session/data/{{data_source}}/connections/{{connection}}
#### Headers
- Content-Type (string, required) - application/json
#### Path Parameters
- data_source (string, required) - Data source
- connection (integer, required) - Connection identifier
#### Query Parameters
- token (string, required) - Auth Token
#### Request Body
**@TODO**
```json
{
"parentIdentifier": "ROOT",
"name": "test",
"identifier": "1",
"activeConnections": 0,
"protocol": "kubernetes",
"parameters": {
"port": "",
"read-only": "",
"swap-red-blue": "",
"cursor": "",
"color-depth": "",
"clipboard-encoding": "",
"disable-copy": "",
"disable-paste": "",
"dest-port": "",
"recording-exclude-output": "",
"recording-exclude-mouse": "",
"recording-include-keys": "",
"create-recording-path": "",
"enable-sftp": "",
"sftp-port": "",
"sftp-server-alive-interval": "",
"enable-audio": "",
"use-ssl": "",
"ignore-cert": "",
"color-scheme": "",
"font-size": "",
"scrollback": "",
"backspace": "",
"create-typescript-path": "",
"hostname": "",
"ca-cert": "",
"namespace": "",
"pod": "",
"container": "",
"client-cert": "",
"client-key": "",
"font-name": "",
"typescript-path": "",
"typescript-name": "",
"recording-path": "",
"recording-name": ""
},
"attributes": {
"max-connections": "",
"max-connections-per-user": "",
"weight": "",
"failover-only": "",
"guacd-port": "",
"guacd-encryption": "",
"guacd-hostname": ""
}
}
```
### Response
#### Status Code
- 204 - No Content
#### Response Body
This request does not return a response body.
---
## Delete Connection
Deletes given connection.
<!-- omit in toc -->
### DELETE /api/session/data/{{data_source}}/connections/{{connection}}
#### Headers
None.
#### Path Parameters
- data_source (string, required) - Data source
- connection (integer, required) - Connection identifier
#### Query Parameters
- token (string, required) - Auth token
#### Request Body
None.
### Response
#### Status Code
- 204 - No Content
#### Response Body
This request does not return a response body.
---
[Back to Top](#connections)
================================================
FILE: docs/EXTENTIONS.md
================================================
<!-- omit in toc -->
# Extentions
Manage extentions.
<!-- omit in toc -->
# Table of Contents
- [Details of Data Source Extentions](#details-of-data-source-extentions)
- [Headers](#headers)
- [Path Parameters](#path-parameters)
- [Query Parameters](#query-parameters)
- [Request Body](#request-body)
- [Response](#response)
- [Status Code](#status-code)
- [Response Body](#response-body)
## Details of Data Source Extentions
Details of data source extentions.
<!-- omit in toc -->
### GET /api/session/ext/{{data_source}}
#### Headers
None.
#### Path Parameters
- data_source (string, required) - Data source
#### Query Parameters
- token (string, required) - Auth Token
#### Request Body
None.
### Response
#### Status Code
- 200 - OK
#### Response Body
**@TODO**
---
[Back to Top](#extentions)
================================================
FILE: docs/HISTORY.md
================================================
<!-- omit in toc -->
# History
History gives you get history log.
<!-- omit in toc -->
# Table of Contents
- [List Connection History](#list-connection-history)
- [Headers](#headers)
- [Path Parameters](#path-parameters)
- [Query Parameters](#query-parameters)
- [Request Body](#request-body)
- [Response](#response)
- [Status Code](#status-code)
- [Response Body](#response-body)
- [List Users History](#list-users-history)
- [Headers](#headers-1)
- [Path Parameters](#path-parameters-1)
- [Query Parameters](#query-parameters-1)
- [Request Body](#request-body-1)
- [Response](#response-1)
- [Status Code](#status-code-1)
- [Response Body](#response-body-1)
## List Connection History
List connection history.
<!-- omit in toc -->
### GET /api/session/data/{{data_source}}/history/connections
#### Headers
None.
#### Path Parameters
- data_source (string, required) - Data source
#### Query Parameters
- token (string, required) - Auth Token
- contains (string, optional) - Contains
- order (string, optional) - Property name to order
#### Request Body
None.
### Response
#### Status Code
- 200 - OK
#### Response Body
**@TODO**
---
## List Users History
List user history.
<!-- omit in toc -->
### GET /api/session/data/{{data_source}}/history/users
#### Headers
None.
#### Path Parameters
- data_source (string, required) - Data source
#### Query Parameters
- token (string, required) - Auth Token
- order (string, optional) - Property name to order
#### Request Body
None.
### Response
#### Status Code
- 200 - OK
#### Response Body
**@TODO**
---
[Back to Top](#history)
================================================
FILE: docs/LANGUAGES.md
================================================
<!-- omit in toc -->
# Languages
Manage languages.
<!-- omit in toc -->
# Table of Contents
- [List Languages](#list-languages)
- [Headers](#headers)
- [Path Parameters](#path-parameters)
- [Query Parameters](#query-parameters)
- [Request Body](#request-body)
- [Response](#response)
- [Status Code](#status-code)
- [Response Body](#response-body)
## List Languages
List languages.
<!-- omit in toc -->
### GET /api/languages
#### Headers
None.
#### Path Parameters
None.
#### Query Parameters
None.
#### Request Body
None.
### Response
#### Status Code
- 200 - OK
#### Response Body
List of languages.
```json
{
"de": "Deutsch",
"no": "Norsk Bokmål",
"ru": "Русский",
"cz": "Čeština",
"ja": "日本語",
"en": "English",
"it": "Italiano",
"fr": "Français",
"nl": "Nederlands",
"zh": "简体中文",
"es": "Spanish"
}
```
---
[Back to Top](#languages)
================================================
FILE: docs/PATCHES.md
================================================
<!-- omit in toc -->
# Patches
Manage patches.
<!-- omit in toc -->
# Table of Contents
- [List Patches](#list-patches)
- [Headers](#headers)
- [Path Parameters](#path-parameters)
- [Query Parameters](#query-parameters)
- [Request Body](#request-body)
- [Response](#response)
- [Status Code](#status-code)
- [Response Body](#response-body)
## List Patches
List patches.
<!-- omit in toc -->
### GET /api/patches
#### Headers
None.
#### Path Parameters
None.
#### Query Parameters
None.
#### Request Body
None.
### Response
#### Status Code
- 200 - OK
#### Response Body
**@TODO**
---
[Back to Top](#patches)
================================================
FILE: docs/PERMISSIONS.md
================================================
<!-- omit in toc -->
# Permissions
Manage permissions.
<!-- omit in toc -->
# Table of Contents
- [Assign System Permissions to User](#assign-system-permissions-to-user)
- [Headers](#headers)
- [Path Parameters](#path-parameters)
- [Query Parameters](#query-parameters)
- [Request Body](#request-body)
- [Response](#response)
- [Status Code](#status-code)
- [Response Body](#response-body)
- [Revoke System Permissions from User](#revoke-system-permissions-from-user)
- [Headers](#headers-1)
- [Path Parameters](#path-parameters-1)
- [Query Parameters](#query-parameters-1)
- [Request Body](#request-body-1)
- [Response](#response-1)
- [Status Code](#status-code-1)
- [Response Body](#response-body-1)
- [Assign Connection Groups to User](#assign-connection-groups-to-user)
- [Headers](#headers-2)
- [Path Parameters](#path-parameters-2)
- [Query Parameters](#query-parameters-2)
- [Request Body](#request-body-2)
- [Response](#response-2)
- [Status Code](#status-code-2)
- [Response Body](#response-body-2)
- [Revoke Connection Group from User](#revoke-connection-group-from-user)
- [Headers](#headers-3)
- [Path Parameters](#path-parameters-3)
- [Query Parameters](#query-parameters-3)
- [Request Body](#request-body-3)
- [Response](#response-3)
- [Status Code](#status-code-3)
- [Response Body](#response-body-3)
- [Assign Connection Groups to User Group](#assign-connection-groups-to-user-group)
- [Headers](#headers-4)
- [Path Parameters](#path-parameters-4)
- [Query Parameters](#query-parameters-4)
- [Request Body](#request-body-4)
- [Response](#response-4)
- [Status Code](#status-code-4)
- [Response Body](#response-body-4)
- [Revoke Connection Group from User Group](#revoke-connection-group-from-user-group)
- [Headers](#headers-5)
- [Path Parameters](#path-parameters-5)
- [Query Parameters](#query-parameters-5)
- [Request Body](#request-body-5)
- [Response](#response-5)
- [Status Code](#status-code-5)
- [Response Body](#response-body-5)
## Assign System Permissions to User
Assign system permissions to an user.
<!-- omit in toc -->
### PATCH /api/session/data/{{data_source}}/users/{{username}}/permissions
#### Headers
- Content-Type (string, required) - application/json
#### Path Parameters
- data_source (string, required) - Data source
- username (string, required) - Username
#### Query Parameters
- token (string, required) - Auth token
#### Request Body
Body must be [json-patch](http://jsonpatch.com/) format.
```json
[
{
"op": "add",
"path": "/userPermissions/test1",
"value": "UPDATE"
},
{
"op": "add",
"path": "/systemPermissions",
"value": "CREATE_USER"
},
{
"op": "add",
"path": "/systemPermissions",
"value": "CREATE_USER_GROUP"
},
{
"op": "add",
"path": "/systemPermissions",
"value": "CREATE_CONNECTION"
},
{
"op": "add",
"path": "/systemPermissions",
"value": "CREATE_CONNECTION_GROUP"
},
{
"op": "add",
"path": "/systemPermissions",
"value": "CREATE_SHARING_PROFILE"
},
{
"op": "add",
"path": "/systemPermissions",
"value": "ADMINISTER"
}
]
```
### Response
#### Status Code
- 204 - No Content
#### Response Body
This request does not return a response body.
---
## Revoke System Permissions from User
Revoke system permissions from an user.
<!-- omit in toc -->
### PATCH /api/session/data/{{data_source}}/users/{{username}}/permissions
#### Headers
- Content-Type (string, required) - application/json
#### Path Parameters
- data_source (string, required) - Data source
- username (string, required) - Username
#### Query Parameters
- token (string, required) - Auth Token
#### Request Body
Body must be [json-patch](http://jsonpatch.com/) format.
```json
[
{
"op": "remove",
"path": "/userPermissions/test1",
"value": "UPDATE"
},
{
"op": "remove",
"path": "/systemPermissions",
"value": "CREATE_SHARING_PROFILE"
},
{
"op": "remove",
"path": "/systemPermissions",
"value": "CREATE_CONNECTION_GROUP"
},
{
"op": "remove",
"path": "/systemPermissions",
"value": "CREATE_CONNECTION"
},
{
"op": "remove",
"path": "/systemPermissions",
"value": "CREATE_USER_GROUP"
},
{
"op": "remove",
"path": "/systemPermissions",
"value": "CREATE_USER"
},
{
"op": "remove",
"path": "/systemPermissions",
"value": "ADMINISTER"
}
]
```
### Response
#### Status Code
- 204 - No Content
#### Response Body
This request does not return a response body.
---
## Assign Connection Groups to User
Assign connection groups to an user.
<!-- omit in toc -->
### PATCH /api/session/data/{{data_source}}/users/{{username}}/permissions
#### Headers
- Content-Type (string, required) - application/json
#### Path Parameters
- data_source (string, required) - Data source
- username (string, required) - Username
#### Query Parameters
- token (string, required) - Auth Token
#### Request Body
Body must be [json-patch](http://jsonpatch.com/) format.
```json
[
{
"op": "add",
"path": "/connectionGroupPermissions/{{connection_group}}",
"value": "READ"
}
]
```
### Response
#### Status Code
- 204 - No Content
#### Response Body
This request does not return a response body.
---
## Revoke Connection Group from User
Revoke connection groups from an user.
<!-- omit in toc -->
### PATCH /api/session/data/{{data_source}}/users/{{username}}/permissions
#### Headers
- Content-Type (string, required) - application/json
#### Path Parameters
- data_source (string, required) - Data source
- username (string, required) - Username
#### Query Parameters
- token (string, required) - Auth Token
#### Request Body
Body must be [json-patch](http://jsonpatch.com/) format.
```json
[
{
"op": "remove",
"path": "/connectionGroupPermissions/{{connection_group}}",
"value": "READ"
}
]
```
### Response
#### Status Code
- 204 - No Content
#### Response Body
This request does not return a response body.
---
## Assign Connection Groups to User Group
Assign connection groups to an user group.
<!-- omit in toc -->
### PATCH /api/session/data/{{data_source}}/userGroups/{{user_group}}/permissions
#### Headers
- Content-Type (string, required) - application/json
#### Path Parameters
- data_source (string, required) - Data source
- user_group (string, required) - User group identifier
#### Query Parameters
- token (string, required) - Auth Token
#### Request Body
Body must be [json-patch](http://jsonpatch.com/) format.
```json
[
{
"op": "add",
"path": "/connectionGroupPermissions/{{connection_group}}",
"value": "READ"
}
]
```
### Response
#### Status Code
- 204 - No Content
#### Response Body
This request does not return a response body.
---
## Revoke Connection Group from User Group
Revoke connection groups from an user group.
<!-- omit in toc -->
### PATCH /api/session/data/{{data_source}}/userGroups/{{user_group}}/permissions
#### Headers
- Content-Type (string, required) - application/json
#### Path Parameters
- data_source (string, required) - Data source
- user_group (string, required) - User group identifier
#### Query Parameters
- token (string, required) - Auth Token
#### Request Body
Body must be [json-patch](http://jsonpatch.com/) format.
```json
[
{
"op": "remove",
"path": "/connectionGroupPermissions/{{connection_group}}",
"value": "READ"
}
]
```
### Response
#### Status Code
- 204 - No Content
#### Response Body
This request does not return a response body.
---
[Back to Top](#permissions)
================================================
FILE: docs/SCHEMAS.md
================================================
<!-- omit in toc -->
# Schemas
Manage schemas.
<!-- omit in toc -->
# Table of Contents
- [List User Attributes Schema](#list-user-attributes-schema)
- [Headers](#headers)
- [Path Parameters](#path-parameters)
- [Query Parameters](#query-parameters)
- [Request Body](#request-body)
- [Response](#response)
- [Status Code](#status-code)
- [Response Body](#response-body)
- [List User Group Attributes Schema](#list-user-group-attributes-schema)
- [Headers](#headers-1)
- [Path Parameters](#path-parameters-1)
- [Query Parameters](#query-parameters-1)
- [Request Body](#request-body-1)
- [Response](#response-1)
- [Status Code](#status-code-1)
- [Response Body](#response-body-1)
- [List Connection Attributes Schema](#list-connection-attributes-schema)
- [Headers](#headers-2)
- [Path Parameters](#path-parameters-2)
- [Query Parameters](#query-parameters-2)
- [Request Body](#request-body-2)
- [Response](#response-2)
- [Status Code](#status-code-2)
- [Response Body](#response-body-2)
- [List Sharing Profile Attributes Schema](#list-sharing-profile-attributes-schema)
- [Headers](#headers-3)
- [Path Parameters](#path-parameters-3)
- [Query Parameters](#query-parameters-3)
- [Request Body](#request-body-3)
- [Response](#response-3)
- [Status Code](#status-code-3)
- [Response Body](#response-body-3)
- [List Connection Group Attributes Schema](#list-connection-group-attributes-schema)
- [Headers](#headers-4)
- [Path Parameters](#path-parameters-4)
- [Query Parameters](#query-parameters-4)
- [Request Body](#request-body-4)
- [Response](#response-4)
- [Status Code](#status-code-4)
- [Response Body](#response-body-4)
- [List Protocols](#list-protocols)
- [Headers](#headers-5)
- [Path Parameters](#path-parameters-5)
- [Query Parameters](#query-parameters-5)
- [Request Body](#request-body-5)
- [Response](#response-5)
- [Status Code](#status-code-5)
- [Response Body](#response-body-5)
## List User Attributes Schema
List user attributes schema.
<!-- omit in toc -->
### GET /api/session/data/{{data_source}}/schema/userAttributes
#### Headers
None.
#### Path Parameters
- data_source (string, required) - Data source
#### Query Parameters
- token (string, required) - Auth Token
#### Request Body
None.
### Response
#### Status Code
- 200 - OK
#### Response Body
**@TODO**
---
## List User Group Attributes Schema
List user group attributes schema.
<!-- omit in toc -->
### GET /api/session/data/{{data_source}}/schema/userGroupAttributes
#### Headers
None.
#### Path Parameters
- data_source (string, required) - Data source
#### Query Parameters
- token (string, required) - Auth Token
#### Request Body
None.
### Response
#### Status Code
- 200 - OK
#### Response Body
**@TODO**
---
## List Connection Attributes Schema
List connection attributes schema.
<!-- omit in toc -->
### GET /api/session/data/{{data_source}}/schema/connectionAttributes
#### Headers
None.
#### Path Parameters
- data_source (string, required) - Data source
#### Query Parameters
- token (string, required) - Auth Token
#### Request Body
None.
### Response
#### Status Code
- 200 - OK
#### Response Body
**@TODO**
---
## List Sharing Profile Attributes Schema
List sharing profile attributes schema.
<!-- omit in toc -->
### GET /api/session/data/{{data_source}}/schema/sharingProfileAttributes
#### Headers
None.
#### Path Parameters
- data_source (string, required) - Data source
#### Query Parameters
- token (string, required) - Auth Token
#### Request Body
None.
### Response
#### Status Code
- 200 - OK
#### Response Body
**@TODO**
---
## List Connection Group Attributes Schema
List connection group attributes schema.
<!-- omit in toc -->
### GET /api/session/data/{{data_source}}/schema/connectionGroupAttributes
#### Headers
None.
#### Path Parameters
- data_source (string, required) - Data source
#### Query Parameters
- token (string, required) - Auth Token
#### Request Body
None.
### Response
#### Status Code
- 200 - OK
#### Response Body
**@TODO**
---
## List Protocols
List protocols.
<!-- omit in toc -->
### GET /api/session/data/{{data_source}}/schema/protocols
#### Headers
None.
#### Path Parameters
- data_source (string, required) - Data source
#### Query Parameters
- token (string, required) - Auth Token
#### Request Body
None.
### Response
#### Status Code
- 200 - OK
#### Response Body
**@TODO**
---
[Back to Top](#schemas)
================================================
FILE: docs/SHARING-PROFILES.md
================================================
<!-- omit in toc -->
# Sharing Profiles
Manage sharing profiles.
<!-- omit in toc -->
# Table of Contents
- [List Sharing Profiles](#list-sharing-profiles)
- [Headers](#headers)
- [Path Parameters](#path-parameters)
- [Query Parameters](#query-parameters)
- [Request Body](#request-body)
- [Response](#response)
- [Status Code](#status-code)
- [Response Body](#response-body)
- [Details of Sharing Profile](#details-of-sharing-profile)
- [Headers](#headers-1)
- [Path Parameters](#path-parameters-1)
- [Query Parameters](#query-parameters-1)
- [Request Body](#request-body-1)
- [Response](#response-1)
- [Status Code](#status-code-1)
- [Response Body](#response-body-1)
- [Create Sharing Profile](#create-sharing-profile)
- [Headers](#headers-2)
- [Path Parameters](#path-parameters-2)
- [Query Parameters](#query-parameters-2)
- [Request Body](#request-body-2)
- [Response](#response-2)
- [Status Code](#status-code-2)
- [Response Body](#response-body-2)
- [Delete Sharing Profile](#delete-sharing-profile)
- [Headers](#headers-3)
- [Path Parameters](#path-parameters-3)
- [Query Parameters](#query-parameters-3)
- [Request Body](#request-body-3)
- [Response](#response-3)
- [Status Code](#status-code-3)
- [Response Body](#response-body-3)
## List Sharing Profiles
<!-- omit in toc -->
### GET /api/session/data/{{data_source}}/sharingProfiles
#### Headers
None.
#### Path Parameters
- data_source (string, required) - Data source
#### Query Parameters
- token (string, required) - Auth Token
#### Request Body
None.
### Response
#### Status Code
- 200 - OK
#### Response Body
**@TODO**
---
## Details of Sharing Profile
Details of sharing profile.
<!-- omit in toc -->
### GET /api/session/data/{{data_source}}/sharingProfiles/{{sharing_profile}}
#### Headers
None.
#### Path Parameters
- data_source (string, required) - Data source
- sharing_profile (string, required) - Sharing profile identifier
#### Query Parameters
- token (string, required) - Auth Token
#### Request Body
None.
### Response
#### Status Code
- 200 - OK
#### Response Body
**@TODO**
---
## Create Sharing Profile
Create a sharing profile.
<!-- omit in toc -->
### POST /api/session/data/{{data_source}}/sharingProfiles
#### Headers
- Content-Type (string, required) - application/json
#### Path Parameters
- data_source (string, required) - Data source
#### Query Parameters
- token (string, required) - Auth Token
#### Request Body
**@TODO**
```json
{
"primaryConnectionIdentifier": "8",
"name": "test",
"parameters": {
"read-only": ""
},
"attributes": {}
}
```
### Response
#### Status Code
- 200 - OK
#### Response Body
**@TODO**
---
## Delete Sharing Profile
Delete sharing profile.
<!-- omit in toc -->
### DELETE /api/session/data/{{data_source}}/sharingProfiles/{{sharing_profile}}
#### Headers
None.
#### Path Parameters
- data_source (string, required) - Data source
- sharing_profile (string, required) - Sharing profile identifier
#### Query Parameters
- token (string, required) - Auth token
#### Request Body
None.
### Response
#### Status Code
- 204 - No Content
#### Response Body
This request does not return a response body.
---
[Back to Top](#sharing-profiles)
================================================
FILE: docs/TUNNELS.md
================================================
<!-- omit in toc -->
# Tunnels
Manage tunnels.
<!-- omit in toc -->
# Table of Contents
- [Details of Tunnel](#details-of-tunnel)
- [Headers](#headers)
- [Path Parameters](#path-parameters)
- [Query Parameters](#query-parameters)
- [Request Body](#request-body)
- [Response](#response)
- [Status Code](#status-code)
- [Response Body](#response-body)
- [List Tunnels](#list-tunnels)
- [Headers](#headers-1)
- [Path Parameters](#path-parameters-1)
- [Query Parameters](#query-parameters-1)
- [Request Body](#request-body-1)
- [Response](#response-1)
- [Status Code](#status-code-1)
- [Response Body](#response-body-1)
## Details of Tunnel
Details of tunnel.
<!-- omit in toc -->
### GET /api/session/tunnels/{{tunnel}}/activeConnection/connection/sharingProfiles
#### Headers
None.
#### Path Parameters
- tunnel (string, required) - Tunnel identifier
#### Query Parameters
- token (string, required) - Auth Token
#### Request Body
None.
### Response
#### Status Code
- 200 - OK
#### Response Body
**@TODO**
---
## List Tunnels
List tunnels.
<!-- omit in toc -->
### GET /api/session/tunnels
#### Headers
None.
#### Path Parameters
None.
#### Query Parameters
- token (string, required) - Auth Token
#### Request Body
None.
### Response
#### Status Code
- 200 - OK
#### Response Body
**@TODO**
---
[Back to Top](#tunnels)
================================================
FILE: docs/USER-GROUPS.md
================================================
<!-- omit in toc -->
# User Groups
Manage user groups.
<!-- omit in toc -->
# Table of Contents
- [List User Groups](#list-user-groups)
- [Headers](#headers)
- [Path Parameters](#path-parameters)
- [Query Parameters](#query-parameters)
- [Request Body](#request-body)
- [Response](#response)
- [Status Code](#status-code)
- [Response Body](#response-body)
- [Details of User Group](#details-of-user-group)
- [Headers](#headers-1)
- [Path Parameters](#path-parameters-1)
- [Query Parameters](#query-parameters-1)
- [Request Body](#request-body-1)
- [Response](#response-1)
- [Status Code](#status-code-1)
- [Response Body](#response-body-1)
- [Add Members to User Group](#add-members-to-user-group)
- [Headers](#headers-2)
- [Path Parameters](#path-parameters-2)
- [Query Parameters](#query-parameters-2)
- [Request Body](#request-body-2)
- [Response](#response-2)
- [Status Code](#status-code-2)
- [Response Body](#response-body-2)
- [Add Member Groups to User Group](#add-member-groups-to-user-group)
- [Headers](#headers-3)
- [Path Parameters](#path-parameters-3)
- [Query Parameters](#query-parameters-3)
- [Request Body](#request-body-3)
- [Response](#response-3)
- [Status Code](#status-code-3)
- [Response Body](#response-body-3)
- [Add Parent Groups to User Group](#add-parent-groups-to-user-group)
- [Headers](#headers-4)
- [Path Parameters](#path-parameters-4)
- [Query Parameters](#query-parameters-4)
- [Request Body](#request-body-4)
- [Response](#response-4)
- [Status Code](#status-code-4)
- [Response Body](#response-body-4)
- [Assign Permissions to User Group](#assign-permissions-to-user-group)
- [Headers](#headers-5)
- [Path Parameters](#path-parameters-5)
- [Query Parameters](#query-parameters-5)
- [Request Body](#request-body-5)
- [Response](#response-5)
- [Status Code](#status-code-5)
- [Response Body](#response-body-5)
- [Revoke Permissions from User Group](#revoke-permissions-from-user-group)
- [Headers](#headers-6)
- [Path Parameters](#path-parameters-6)
- [Query Parameters](#query-parameters-6)
- [Request Body](#request-body-6)
- [Response](#response-6)
- [Status Code](#status-code-6)
- [Response Body](#response-body-6)
- [Assign Connections to User Group](#assign-connections-to-user-group)
- [Headers](#headers-7)
- [Path Parameters](#path-parameters-7)
- [Query Parameters](#query-parameters-7)
- [Request Body](#request-body-7)
- [Response](#response-7)
- [Status Code](#status-code-7)
- [Response Body](#response-body-7)
- [Revoke Connections from User Group](#revoke-connections-from-user-group)
- [Headers](#headers-8)
- [Path Parameters](#path-parameters-8)
- [Query Parameters](#query-parameters-8)
- [Request Body](#request-body-8)
- [Response](#response-8)
- [Status Code](#status-code-8)
- [Response Body](#response-body-8)
- [Update User Group](#update-user-group)
- [Headers](#headers-9)
- [Path Parameters](#path-parameters-9)
- [Query Parameters](#query-parameters-9)
- [Request Body](#request-body-9)
- [Response](#response-9)
- [Status Code](#status-code-9)
- [Response Body](#response-body-9)
- [Create User Group](#create-user-group)
- [Headers](#headers-10)
- [Path Parameters](#path-parameters-10)
- [Query Parameters](#query-parameters-10)
- [Request Body](#request-body-10)
- [Response](#response-10)
- [Status Code](#status-code-10)
- [Response Body](#response-body-10)
- [Delete User Group](#delete-user-group)
- [Headers](#headers-11)
- [Path Parameters](#path-parameters-11)
- [Query Parameters](#query-parameters-11)
- [Request Body](#request-body-11)
- [Response](#response-11)
- [Status Code](#status-code-11)
- [Response Body](#response-body-11)
## List User Groups
<!-- omit in toc -->
### GET /api/session/data/{{data_source}}/userGroups
#### Headers
None.
#### Path Parameters
- data_source (string, required) - Data source
#### Query Parameters
- token (string, required) - Auth Token
#### Request Body
None.
### Response
#### Status Code
- 200 - OK
#### Response Body
**@TODO**
---
## Details of User Group
<!-- omit in toc -->
### GET /api/session/data/{{data_source}}/userGroups/{{user_group}}
#### Headers
None.
#### Path Parameters
- data_source (string, required) - Data source
- user_group (string, required) - User group identifier
#### Query Parameters
- token (string, required) - Auth Token
#### Request Body
None.
### Response
#### Status Code
- 200 - OK
#### Response Body
**@TODO**
---
## Add Members to User Group
Add members to an user group.
<!-- omit in toc -->
### PATCH /api/session/data/{{data_source}}/userGroups/{{user_group}}/memberUsers
#### Headers
- Content-Type (string, required) - application/json
#### Path Parameters
- data_source (string, required) - Data source
- user_group (string, required) - User group identifier
#### Query Parameters
- token (string, required) - Auth Token
#### Request Body
Body must be [json-patch](http://jsonpatch.com/) format.
```json
[
{
"op": "add",
"path": "/",
"value": "{{username}}"
}
]
```
### Response
#### Status Code
- 204 - No Content
#### Response Body
This request does not return a response body.
---
## Add Member Groups to User Group
Add member groups to an user group.
<!-- omit in toc -->
### PATCH /api/session/data/{{data_source}}/userGroups/{{user_group}}/memberUserGroups
#### Headers
- Content-Type (string, required) - application/json
#### Path Parameters
- data_source (string, required) - Data source
- user_group (string, required) - User group identifier
#### Query Parameters
- token (string, required) - Auth Token
#### Request Body
Body must be [json-patch](http://jsonpatch.com/) format.
```json
[
{
"op": "add",
"path": "/",
"value": "{{userGroupIdentifier}}"
}
]
```
### Response
#### Status Code
- 204 - No Content
#### Response Body
This request does not return a response body.
---
## Add Parent Groups to User Group
Add parent groups to an user group.
<!-- omit in toc -->
### PATCH /api/session/data/{{data_source}}/userGroups/{{user_group}}/userGroups
#### Headers
- Content-Type (string, required) - application/json
#### Path Parameters
- data_source (string, required) - Data source
- user_group (string, required) - User group identifier
#### Query Parameters
- token (string, required) - Auth Token
#### Request Body
Body must be [json-patch](http://jsonpatch.com/) format.
```json
[
{
"op": "add",
"path": "/",
"value": "{{userGroupIdentifier}}"
}
]
```
### Response
#### Status Code
- 204 - No Content
#### Response Body
This request does not return a response body.
---
## Assign Permissions to User Group
Assign permissions to an user group.
<!-- omit in toc -->
### PATCH /api/session/data/{{data_source}}/userGroups/{{user_group}}/permissions
#### Headers
- Content-Type (string, required) - application/json
#### Path Parameters
- data_source (string, required) - Data source
- user_group (string, required) - User group identifier
#### Query Parameters
- token (string, required) - Auth Token
#### Request Body
Body must be [json-patch](http://jsonpatch.com/) format.
```json
[
{
"op": "add",
"path": "/connectionPermissions/{{user_group}}",
"value": "READ"
},
{
"op": "add",
"path": "/systemPermissions",
"value": "CREATE_USER"
},
{
"op": "add",
"path": "/systemPermissions",
"value": "ADMINISTER"
},
{
"op": "add",
"path": "/systemPermissions",
"value": "CREATE_USER_GROUP"
},
{
"op": "add",
"path": "/systemPermissions",
"value": "CREATE_CONNECTION"
},
{
"op": "add",
"path": "/systemPermissions",
"value": "CREATE_SHARING_PROFILE"
},
{
"op": "add",
"path": "/systemPermissions",
"value": "CREATE_CONNECTION_GROUP"
}
]
```
### Response
#### Status Code
- 204 - No Content
#### Response Body
This request does not return a response body.
---
## Revoke Permissions from User Group
Revoke permissions from an user group.
<!-- omit in toc -->
### PATCH /api/session/data/{{data_source}}/userGroups/{{user_group}}/permissions
#### Headers
- Content-Type (string, required) - application/json
#### Path Parameters
- data_source (string, required) - Data source
- user_group (string, required) - User group identifier
#### Query Parameters
- token (string, required) - Auth Token
#### Request Body
Body must be [json-patch](http://jsonpatch.com/) format.
```json
[
{
"op": "remove",
"path": "/connectionPermissions/{{user_group}}",
"value": "READ"
},
{
"op": "remove",
"path": "/systemPermissions",
"value": "CREATE_USER"
},
{
"op": "remove",
"path": "/systemPermissions",
"value": "ADMINISTER"
},
{
"op": "remove",
"path": "/systemPermissions",
"value": "CREATE_USER_GROUP"
},
{
"op": "remove",
"path": "/systemPermissions",
"value": "CREATE_CONNECTION"
},
{
"op": "remove",
"path": "/systemPermissions",
"value": "CREATE_SHARING_PROFILE"
},
{
"op": "remove",
"path": "/systemPermissions",
"value": "CREATE_CONNECTION_GROUP"
}
]
```
### Response
#### Status Code
- 204 - No Content
#### Response Body
This request does not return a response body.
---
## Assign Connections to User Group
Assign connections to an user group
<!-- omit in toc -->
### PATCH /api/session/data/{{data_source}}/userGroups/{{user_group}}/permissions
#### Headers
- Content-Type (string, required) - application/json
#### Path Parameters
- data_source (string, required) - Data source
- user_group (string, required) - User group identifier
#### Query Parameters
- token (string, required) - Auth Token
#### Request Body
Body must be [json-patch](http://jsonpatch.com/) format.
```json
[
{
"op": "add",
"path": "/connectionPermissions/{{connection}}",
"value": "READ"
}
]
```
### Response
#### Status Code
- 204 - No Content
#### Response Body
This request does not return a response body.
---
## Revoke Connections from User Group
Revoke connections from an user group.
<!-- omit in toc -->
### PATCH /api/session/data/{{data_source}}/userGroups/{{user_group}}/permissions
#### Headers
- Content-Type (string, required) - application/json
#### Path Parameters
- data_source (string, required) - Data source
- user_group (string, required) - User group identifier
#### Query Parameters
- token (string, required) - Auth Token
#### Request Body
Body must be [json-patch](http://jsonpatch.com/) format.
```json
[
{
"op": "remove",
"path": "/connectionPermissions/{{connection}}",
"value": "READ"
}
]
```
### Response
#### Status Code
- 204 - No Content
#### Response Body
This request does not return a response body.
---
## Update User Group
Updates user group.
<!-- omit in toc -->
### PUT /api/session/data/{{data_source}}/userGroups/{{user_group}}
#### Headers
- Content-Type (string, required) - application/json
#### Path Parameters
- data_source (string, required) - Data source
- user_group (string, required) - User group identifier
#### Query Parameters
- token (string, required) - Auth Token
#### Request Body
**@TODO**
```json
{
"identifier": "test",
"attributes": {
"disabled": ""
}
}
```
### Response
#### Status Code
- 204 - No Content
#### Response Body
This request does not return a response body.
---
## Create User Group
Create a user group.
<!-- omit in toc -->
### POST /api/session/data/{{data_source}}/userGroups
#### Headers
- Content-Type (string, required) - application/json
#### Path Parameters
- data_source (string, required) - Data source
#### Query Parameters
- token (string, required) - Auth Token
#### Request Body
**@TODO**
```json
{
"identifier": "test",
"attributes": {
"disabled": ""
}
}
```
### Response
#### Status Code
- 204 - No Content
#### Response Body
This request does not return a response body.
---
## Delete User Group
Delete user group.
<!-- omit in toc -->
### DELETE /api/session/data/{{data_source}}/userGroups/{{user_group}}
#### Headers
None.
#### Path Parameters
- data_source (string, required) - Data source
- user_group (string, required) - User group identifier
#### Query Parameters
- token (string, required) - Auth token
#### Request Body
None.
### Response
#### Status Code
- 204 - No Content
#### Response Body
This request does not return a response body.
---
[Back to Top](#user-groups)
================================================
FILE: docs/USERS.md
================================================
<!-- omit in toc -->
# Users
Manage users.
<!-- omit in toc -->
# Table of Contents
- [List Users](#list-users)
- [Headers](#headers)
- [Path Parameters](#path-parameters)
- [Query Parameters](#query-parameters)
- [Request Body](#request-body)
- [Response](#response)
- [Status Code](#status-code)
- [Response Body](#response-body)
- [Details of User](#details-of-user)
- [Headers](#headers-1)
- [Path Parameters](#path-parameters-1)
- [Query Parameters](#query-parameters-1)
- [Request Body](#request-body-1)
- [Response](#response-1)
- [Status Code](#status-code-1)
- [Response Body](#response-body-1)
- [Details of Self](#details-of-self)
- [Headers](#headers-2)
- [Path Parameters](#path-parameters-2)
- [Query Parameters](#query-parameters-2)
- [Request Body](#request-body-2)
- [Response](#response-2)
- [Status Code](#status-code-2)
- [Response Body](#response-body-2)
- [Details of User Permissions](#details-of-user-permissions)
- [Headers](#headers-3)
- [Path Parameters](#path-parameters-3)
- [Query Parameters](#query-parameters-3)
- [Request Body](#request-body-3)
- [Response](#response-3)
- [Status Code](#status-code-3)
- [Response Body](#response-body-3)
- [Details of User Effective Permissions](#details-of-user-effective-permissions)
- [Headers](#headers-4)
- [Path Parameters](#path-parameters-4)
- [Query Parameters](#query-parameters-4)
- [Request Body](#request-body-4)
- [Response](#response-4)
- [Status Code](#status-code-4)
- [Response Body](#response-body-4)
- [Details of User Groups](#details-of-user-groups)
- [Headers](#headers-5)
- [Path Parameters](#path-parameters-5)
- [Query Parameters](#query-parameters-5)
- [Request Body](#request-body-5)
- [Response](#response-5)
- [Status Code](#status-code-5)
- [Response Body](#response-body-5)
- [Details of User History](#details-of-user-history)
- [Headers](#headers-6)
- [Path Parameters](#path-parameters-6)
- [Query Parameters](#query-parameters-6)
- [Request Body](#request-body-6)
- [Response](#response-6)
- [Status Code](#status-code-6)
- [Response Body](#response-body-6)
- [Assign User to User Groups](#assign-user-to-user-groups)
- [Headers](#headers-7)
- [Path Parameters](#path-parameters-7)
- [Query Parameters](#query-parameters-7)
- [Request Body](#request-body-7)
- [Response](#response-7)
- [Status Code](#status-code-7)
- [Response Body](#response-body-7)
- [Revoke User from User Groups](#revoke-user-from-user-groups)
- [Headers](#headers-8)
- [Path Parameters](#path-parameters-8)
- [Query Parameters](#query-parameters-8)
- [Request Body](#request-body-8)
- [Response](#response-8)
- [Status Code](#status-code-8)
- [Response Body](#response-body-8)
- [Assign User to Connections](#assign-user-to-connections)
- [Headers](#headers-9)
- [Path Parameters](#path-parameters-9)
- [Query Parameters](#query-parameters-9)
- [Request Body](#request-body-9)
- [Response](#response-9)
- [Status Code](#status-code-9)
- [Response Body](#response-body-9)
- [Revoke User from Connections](#revoke-user-from-connections)
- [Headers](#headers-10)
- [Path Parameters](#path-parameters-10)
- [Query Parameters](#query-parameters-10)
- [Request Body](#request-body-10)
- [Response](#response-10)
- [Status Code](#status-code-10)
- [Response Body](#response-body-10)
- [Update User Password](#update-user-password)
- [Headers](#headers-11)
- [Path Parameters](#path-parameters-11)
- [Query Parameters](#query-parameters-11)
- [Request Body](#request-body-11)
- [Response](#response-11)
- [Status Code](#status-code-11)
- [Response Body](#response-body-11)
- [Update User](#update-user)
- [Headers](#headers-12)
- [Path Parameters](#path-parameters-12)
- [Query Parameters](#query-parameters-12)
- [Request Body](#request-body-12)
- [Response](#response-12)
- [Status Code](#status-code-12)
- [Response Body](#response-body-12)
- [Create User](#create-user)
- [Headers](#headers-13)
- [Path Parameters](#path-parameters-13)
- [Query Parameters](#query-parameters-13)
- [Request Body](#request-body-13)
- [Response](#response-13)
- [Status Code](#status-code-13)
- [Response Body](#response-body-13)
- [Delete User](#delete-user)
- [Headers](#headers-14)
- [Path Parameters](#path-parameters-14)
- [Query Parameters](#query-parameters-14)
- [Request Body](#request-body-14)
- [Response](#response-14)
- [Status Code](#status-code-14)
- [Response Body](#response-body-14)
## List Users
List users.
<!-- omit in toc -->
### GET /api/session/data/{{data_source}}/users
#### Headers
None.
#### Path Parameters
- data_source (string, required) - Data source
#### Query Parameters
- token (string, required) - Auth token
#### Request Body
None.
### Response
#### Status Code
- 200 - OK
#### Response Body
**@TODO**
---
## Details of User
Details of user.
<!-- omit in toc -->
### GET /api/session/data/{{data_source}}/users/{{username}}
#### Headers
None.
#### Path Parameters
- data_source (string, required) - Data source
- username (string, required) - Username
#### Query Parameters
- token (string, required) - Auth Token
#### Request Body
None.
### Response
#### Status Code
- 200 - OK
#### Response Body
**@TODO**
---
## Details of Self
Details of token owner.
<!-- omit in toc -->
### GET /api/session/data/{{data_source}}/self
#### Headers
None.
#### Path Parameters
- data_source (string, required) - Data source
#### Query Parameters
- token (string, required) - Auth token
#### Request Body
None.
### Response
#### Status Code
- 200 - OK
#### Response Body
**@TODO**
---
## Details of User Permissions
Details of user permissions.
<!-- omit in toc -->
### GET /api/session/data/{{data_source}}/users/{{username}}/permissions
#### Headers
None.
#### Path Parameters
- data_source (string, required) - Data source
- username (string, required) - Username
#### Query Parameters
- token (string, required) - Auth Token
#### Request Body
None.
### Response
#### Status Code
- 200 - OK
#### Response Body
**@TODO**
---
## Details of User Effective Permissions
Details of user effective permissions.
<!-- omit in toc -->
### GET /api/session/data/{{data_source}}/users/{{username}}/effectivePermissions
#### Headers
None.
#### Path Parameters
- data_source (string, required) - Data source
- username (string, required) - Username
#### Query Parameters
- token (string, required) - Auth Token
#### Request Body
None.
### Response
#### Status Code
- 200 - OK
#### Response Body
**@TODO**
---
## Details of User Groups
Details of user groups.
<!-- omit in toc -->
### GET /api/session/data/{{data_source}}/users/{{username}}/userGroups
#### Headers
None.
#### Path Parameters
- data_source (string, required) - Data source
- username (string, required) - Username
#### Query Parameters
- token (string, required) - Auth Token
#### Request Body
None.
### Response
#### Status Code
- 200 - OK
#### Response Body
**@TODO**
---
## Details of User History
Details of user history.
<!-- omit in toc -->
### GET /api/session/data/{{data_source}}/users/{{username}}/history
#### Headers
None.
#### Path Parameters
- data_source (string, required) - Data source
- username (string, required) - Username
#### Query Parameters
- token (string, required) - Auth Token
#### Request Body
None.
### Response
#### Status Code
- 200 - OK
#### Response Body
**@TODO**
---
## Assign User to User Groups
Assign user to user groups.
<!-- omit in toc -->
### PATCH /api/session/data/{{data_source}}/users/{{username}}/userGroups
#### Headers
- Content-Type (string, required) - application/json
#### Path Parameters
- data_source (string, required) - Data source
- username (string, required) - Username
#### Query Parameters
- token (string, required) - Auth Token
#### Request Body
Body must be [json-patch](http://jsonpatch.com/) format.
```json
[
{
"op": "add",
"path": "/",
"value": "{{user_group}}"
}
]
```
### Response
#### Status Code
- 204 - No Content
#### Response Body
This request does not return a response body.
---
## Revoke User from User Groups
Revoke user from user groups.
<!-- omit in toc -->
### PATCH /api/session/data/{{data_source}}/users/{{username}}/userGroups
#### Headers
- Content-Type (string, required) - application/json
#### Path Parameters
- data_source (string, required) - Data source
- username (string, required) - Username
#### Query Parameters
- token (string, required) - Auth Token
#### Request Body
Body must be [json-patch](http://jsonpatch.com/) format.
```json
[
{
"op": "remove",
"path": "/",
"value": "{{user_group}}"
}
]
```
### Response
#### Status Code
- 204 - No Content
#### Response Body
This request does not return a response body.
---
## Assign User to Connections
Assign user to connections.
<!-- omit in toc -->
### PATCH /api/session/data/{{data_source}}/users/{{username}}/permissions
#### Headers
- Content-Type (string, required) - application/json
#### Path Parameters
- data_source (string, required) - Data source
- username (string, required) - Username
#### Query Parameters
- token (string, required) - Auth Token
#### Request Body
Body must be [json-patch](http://jsonpatch.com/) format.
```json
[
{
"op": "add",
"path": "/connectionPermissions/{{connectionId}}",
"value": "READ"
}
]
```
You may also include connection groups (folders), and must if the connection that you wish to allow access to is within a connection group.
```json
[
{
"op": "add",
"path": "/connectionGroupPermissions/{{connectionGroupId}}",
"value": "READ"
}
]
```
### Response
#### Status Code
- 204 - No Content
#### Response Body
This request does not return a response body.
---
## Revoke User from Connections
Revoke user from connections.
<!-- omit in toc -->
### PATCH /api/session/data/{{data_source}}/users/{{username}}/permissions
#### Headers
- Content-Type (string, required) - application/json
#### Path Parameters
- data_source (string, required) - Data source
- username (string, required) - Username
#### Query Parameters
- token (string, required) - Auth Token
#### Request Body
Body must be [json-patch](http://jsonpatch.com/) format.
```json
[
{
"op": "remove",
"path": "/connectionPermissions/{{connectionId}}",
"value": "READ"
}
]
```
You may also include connection groups (folders)
```json
[
{
"op": "remove",
"path": "/connectionGroupPermissions/{{connectionGroupId}}",
"value": "READ"
}
]
```
### Response
#### Status Code
- 204 - No Content
#### Response Body
This request does not return a response body.
---
## Update User Password
Updates user password.
<!-- omit in toc -->
### PUT /api/session/data/{{data_source}}/users/{{username}}/password
#### Headers
- Content-Type (string, required) - application/json
#### Path Parameters
- data_source (string, required) - Data source
- username (string, required) - Username
#### Query Parameters
- token (string, required) - Auth Token
#### Request Body
- oldPassword (string, required) - Old password
- newPassword (string, required) - New password
```json
{
"oldPassword": "{{oldPassword}}",
"newPassword": "{{newPassword}}"
}
```
### Response
#### Status Code
- 204 - No Content
#### Response Body
This request does not return a response body.
---
## Update User
Updates user.
<!-- omit in toc -->
### PUT /api/session/data/{{data_source}}/users/{{username}}
#### Headers
- Content-Type (string, required) - application/json
#### Path Parameters
- data_source (string, required) - Data source
- username (string, required) - Username
#### Query Parameters
- token (string, required) - Auth Token
#### Request Body
**@TODO**
```json
{
"username": "{{username}}",
"attributes": {
"guac-email-address": null,
"guac-organizational-role": null,
"guac-full-name": null,
"expired": "",
"timezone": null,
"access-window-start": "",
"guac-organization": null,
"access-window-end": "",
"disabled": "",
"valid-until": "",
"valid-from": ""
}
}
```
### Response
#### Status Code
- 204 - No Content
#### Response Body
This request does not return a response body.
---
## Create User
Creates a user.
<!-- omit in toc -->
### POST /api/session/data/{{data_source}}/users
#### Headers
- Content-Type (string, required) - application/json
#### Path Parameters
- data_source (string, required) - Data source
#### Query Parameters
- token (string, required) - Auth Token
#### Request Body
**@TODO**
```json
{
"username": "test",
"password": "pass",
"attributes": {
"disabled": "",
"expired": "",
"access-window-start": "",
"access-window-end": "",
"valid-from": "",
"valid-until": "",
"timezone": null,
"guac-full-name": "",
"guac-organization": "",
"guac-organizational-role": ""
}
}
```
### Response
#### Status Code
- 200 - OK
#### Response Body
**@TODO**
## Delete User
Delete user.
<!-- omit in toc -->
### DELETE /api/session/data/{{data_source}}/users/{{username}}
#### Headers
None.
#### Path Parameters
- data_source (string, required) - Data source
- username (integer, required) - Username
#### Query Parameters
- token (string, required) - Auth token
#### Request Body
None.
### Response
#### Status Code
- 204 - No Content
#### Response Body
This request does not return a response body.
---
[Back to Top](#users)
gitextract_sz567z4i/
├── README.md
└── docs/
├── AUTHENTICATION.md
├── CONNECTION-GROUPS.md
├── CONNECTIONS.md
├── EXTENTIONS.md
├── HISTORY.md
├── LANGUAGES.md
├── PATCHES.md
├── PERMISSIONS.md
├── SCHEMAS.md
├── SHARING-PROFILES.md
├── TUNNELS.md
├── USER-GROUPS.md
└── USERS.md
Condensed preview — 14 files, each showing path, character count, and a content snippet. Download the .json file or copy for the full structured content (96K chars).
[
{
"path": "README.md",
"chars": 2827,
"preview": "<!-- omit in toc -->\n# Guacamole Web REST API\n\nGuacamole REST API gives you access and manage Guacamole Web Application."
},
{
"path": "docs/AUTHENTICATION.md",
"chars": 2015,
"preview": "<!-- omit in toc -->\n# Authentication\n\nAuthentication allows you create and delete tokens.\n\n<!-- omit in toc -->\n# Table"
},
{
"path": "docs/CONNECTION-GROUPS.md",
"chars": 6295,
"preview": "<!-- omit in toc -->\n# Connection Groups\n\nManage connection groups.\n\n<!-- omit in toc -->\n# Table of Contents\n\n- [List C"
},
{
"path": "docs/CONNECTIONS.md",
"chars": 29049,
"preview": "<!-- omit in toc -->\n# Connections\n\nManage connections.\n\n<!-- omit in toc -->\n# Table of Contents\n\n- [List Connections]("
},
{
"path": "docs/EXTENTIONS.md",
"chars": 843,
"preview": "<!-- omit in toc -->\n# Extentions\n\nManage extentions.\n\n<!-- omit in toc -->\n# Table of Contents\n\n- [Details of Data Sour"
},
{
"path": "docs/HISTORY.md",
"chars": 1665,
"preview": "<!-- omit in toc -->\n# History\n\nHistory gives you get history log.\n\n<!-- omit in toc -->\n# Table of Contents\n\n- [List Co"
},
{
"path": "docs/LANGUAGES.md",
"chars": 908,
"preview": "<!-- omit in toc -->\n# Languages\n\nManage languages.\n\n<!-- omit in toc -->\n# Table of Contents\n\n- [List Languages](#list-"
},
{
"path": "docs/PATCHES.md",
"chars": 655,
"preview": "<!-- omit in toc -->\n# Patches\n\nManage patches.\n\n<!-- omit in toc -->\n# Table of Contents\n\n- [List Patches](#list-patche"
},
{
"path": "docs/PERMISSIONS.md",
"chars": 7767,
"preview": "<!-- omit in toc -->\n# Permissions\n\nManage permissions.\n\n<!-- omit in toc -->\n# Table of Contents\n\n- [Assign System Perm"
},
{
"path": "docs/SCHEMAS.md",
"chars": 4603,
"preview": "<!-- omit in toc -->\n# Schemas\n\nManage schemas.\n\n<!-- omit in toc -->\n# Table of Contents\n\n- [List User Attributes Schem"
},
{
"path": "docs/SHARING-PROFILES.md",
"chars": 3345,
"preview": "<!-- omit in toc -->\n# Sharing Profiles\n\nManage sharing profiles.\n\n<!-- omit in toc -->\n# Table of Contents\n\n- [List Sha"
},
{
"path": "docs/TUNNELS.md",
"chars": 1409,
"preview": "<!-- omit in toc -->\n# Tunnels\n\nManage tunnels.\n\n<!-- omit in toc -->\n# Table of Contents\n\n- [Details of Tunnel](#detail"
},
{
"path": "docs/USER-GROUPS.md",
"chars": 12767,
"preview": "<!-- omit in toc -->\n# User Groups\n\nManage user groups.\n\n<!-- omit in toc -->\n# Table of Contents\n\n- [List User Groups]("
},
{
"path": "docs/USERS.md",
"chars": 13846,
"preview": "<!-- omit in toc -->\n# Users\n\nManage users.\n\n<!-- omit in toc -->\n# Table of Contents\n\n- [List Users](#list-users)\n -"
}
]
About this extraction
This page contains the full source code of the ridvanaltun/guacamole-rest-api-documentation GitHub repository, extracted and formatted as plain text for AI agents and large language models (LLMs). The extraction includes 14 files (85.9 KB), approximately 23.6k tokens. Use this with OpenClaw, Claude, ChatGPT, Cursor, Windsurf, or any other AI tool that accepts text input. You can copy the full output to your clipboard or download it as a .txt file.
Extracted by GitExtract — free GitHub repo to text converter for AI. Built by Nikandr Surkov.