├── docs ├── PATCHES.md ├── EXTENTIONS.md ├── LANGUAGES.md ├── TUNNELS.md ├── HISTORY.md ├── AUTHENTICATION.md ├── SHARING-PROFILES.md ├── SCHEMAS.md ├── CONNECTION-GROUPS.md ├── PERMISSIONS.md ├── USER-GROUPS.md ├── USERS.md └── CONNECTIONS.md └── README.md /docs/PATCHES.md: -------------------------------------------------------------------------------- 1 | 2 | # Patches 3 | 4 | Manage patches. 5 | 6 | 7 | # Table of Contents 8 | 9 | - [List Patches](#list-patches) 10 | - [Headers](#headers) 11 | - [Path Parameters](#path-parameters) 12 | - [Query Parameters](#query-parameters) 13 | - [Request Body](#request-body) 14 | - [Response](#response) 15 | - [Status Code](#status-code) 16 | - [Response Body](#response-body) 17 | 18 | ## List Patches 19 | 20 | List patches. 21 | 22 | 23 | ### GET /api/patches 24 | 25 | #### Headers 26 | 27 | None. 28 | 29 | #### Path Parameters 30 | 31 | None. 32 | 33 | #### Query Parameters 34 | 35 | None. 36 | 37 | #### Request Body 38 | 39 | None. 40 | 41 | ### Response 42 | 43 | #### Status Code 44 | 45 | - 200 - OK 46 | 47 | #### Response Body 48 | 49 | **@TODO** 50 | 51 | --- 52 | 53 | [Back to Top](#patches) 54 | -------------------------------------------------------------------------------- /docs/EXTENTIONS.md: -------------------------------------------------------------------------------- 1 | 2 | # Extentions 3 | 4 | Manage extentions. 5 | 6 | 7 | # Table of Contents 8 | 9 | - [Details of Data Source Extentions](#details-of-data-source-extentions) 10 | - [Headers](#headers) 11 | - [Path Parameters](#path-parameters) 12 | - [Query Parameters](#query-parameters) 13 | - [Request Body](#request-body) 14 | - [Response](#response) 15 | - [Status Code](#status-code) 16 | - [Response Body](#response-body) 17 | 18 | ## Details of Data Source Extentions 19 | 20 | Details of data source extentions. 21 | 22 | 23 | ### GET /api/session/ext/{{data_source}} 24 | 25 | #### Headers 26 | 27 | None. 28 | 29 | #### Path Parameters 30 | 31 | - data_source (string, required) - Data source 32 | 33 | #### Query Parameters 34 | 35 | - token (string, required) - Auth Token 36 | 37 | #### Request Body 38 | 39 | None. 40 | 41 | ### Response 42 | 43 | #### Status Code 44 | 45 | - 200 - OK 46 | 47 | #### Response Body 48 | 49 | **@TODO** 50 | 51 | --- 52 | 53 | [Back to Top](#extentions) 54 | -------------------------------------------------------------------------------- /docs/LANGUAGES.md: -------------------------------------------------------------------------------- 1 | 2 | # Languages 3 | 4 | Manage languages. 5 | 6 | 7 | # Table of Contents 8 | 9 | - [List Languages](#list-languages) 10 | - [Headers](#headers) 11 | - [Path Parameters](#path-parameters) 12 | - [Query Parameters](#query-parameters) 13 | - [Request Body](#request-body) 14 | - [Response](#response) 15 | - [Status Code](#status-code) 16 | - [Response Body](#response-body) 17 | 18 | ## List Languages 19 | 20 | List languages. 21 | 22 | 23 | ### GET /api/languages 24 | 25 | #### Headers 26 | 27 | None. 28 | 29 | #### Path Parameters 30 | 31 | None. 32 | 33 | #### Query Parameters 34 | 35 | None. 36 | 37 | #### Request Body 38 | 39 | None. 40 | 41 | ### Response 42 | 43 | #### Status Code 44 | 45 | - 200 - OK 46 | 47 | #### Response Body 48 | 49 | List of languages. 50 | 51 | ```json 52 | { 53 | "de": "Deutsch", 54 | "no": "Norsk Bokmål", 55 | "ru": "Русский", 56 | "cz": "Čeština", 57 | "ja": "日本語", 58 | "en": "English", 59 | "it": "Italiano", 60 | "fr": "Français", 61 | "nl": "Nederlands", 62 | "zh": "简体中文", 63 | "es": "Spanish" 64 | } 65 | ``` 66 | 67 | --- 68 | 69 | [Back to Top](#languages) 70 | -------------------------------------------------------------------------------- /docs/TUNNELS.md: -------------------------------------------------------------------------------- 1 | 2 | # Tunnels 3 | 4 | Manage tunnels. 5 | 6 | 7 | # Table of Contents 8 | 9 | - [Details of Tunnel](#details-of-tunnel) 10 | - [Headers](#headers) 11 | - [Path Parameters](#path-parameters) 12 | - [Query Parameters](#query-parameters) 13 | - [Request Body](#request-body) 14 | - [Response](#response) 15 | - [Status Code](#status-code) 16 | - [Response Body](#response-body) 17 | - [List Tunnels](#list-tunnels) 18 | - [Headers](#headers-1) 19 | - [Path Parameters](#path-parameters-1) 20 | - [Query Parameters](#query-parameters-1) 21 | - [Request Body](#request-body-1) 22 | - [Response](#response-1) 23 | - [Status Code](#status-code-1) 24 | - [Response Body](#response-body-1) 25 | 26 | ## Details of Tunnel 27 | 28 | Details of tunnel. 29 | 30 | 31 | ### GET /api/session/tunnels/{{tunnel}}/activeConnection/connection/sharingProfiles 32 | 33 | #### Headers 34 | 35 | None. 36 | 37 | #### Path Parameters 38 | 39 | - tunnel (string, required) - Tunnel identifier 40 | 41 | #### Query Parameters 42 | 43 | - token (string, required) - Auth Token 44 | 45 | #### Request Body 46 | 47 | None. 48 | 49 | ### Response 50 | 51 | #### Status Code 52 | 53 | - 200 - OK 54 | 55 | #### Response Body 56 | 57 | **@TODO** 58 | 59 | --- 60 | 61 | ## List Tunnels 62 | 63 | List tunnels. 64 | 65 | 66 | ### GET /api/session/tunnels 67 | 68 | #### Headers 69 | 70 | None. 71 | 72 | #### Path Parameters 73 | 74 | None. 75 | 76 | #### Query Parameters 77 | 78 | - token (string, required) - Auth Token 79 | 80 | #### Request Body 81 | 82 | None. 83 | 84 | ### Response 85 | 86 | #### Status Code 87 | 88 | - 200 - OK 89 | 90 | #### Response Body 91 | 92 | **@TODO** 93 | 94 | --- 95 | 96 | [Back to Top](#tunnels) 97 | -------------------------------------------------------------------------------- /docs/HISTORY.md: -------------------------------------------------------------------------------- 1 | 2 | # History 3 | 4 | History gives you get history log. 5 | 6 | 7 | # Table of Contents 8 | 9 | - [List Connection History](#list-connection-history) 10 | - [Headers](#headers) 11 | - [Path Parameters](#path-parameters) 12 | - [Query Parameters](#query-parameters) 13 | - [Request Body](#request-body) 14 | - [Response](#response) 15 | - [Status Code](#status-code) 16 | - [Response Body](#response-body) 17 | - [List Users History](#list-users-history) 18 | - [Headers](#headers-1) 19 | - [Path Parameters](#path-parameters-1) 20 | - [Query Parameters](#query-parameters-1) 21 | - [Request Body](#request-body-1) 22 | - [Response](#response-1) 23 | - [Status Code](#status-code-1) 24 | - [Response Body](#response-body-1) 25 | 26 | ## List Connection History 27 | 28 | List connection history. 29 | 30 | 31 | ### GET /api/session/data/{{data_source}}/history/connections 32 | 33 | #### Headers 34 | 35 | None. 36 | 37 | #### Path Parameters 38 | 39 | - data_source (string, required) - Data source 40 | 41 | #### Query Parameters 42 | 43 | - token (string, required) - Auth Token 44 | - contains (string, optional) - Contains 45 | - order (string, optional) - Property name to order 46 | 47 | #### Request Body 48 | 49 | None. 50 | 51 | ### Response 52 | 53 | #### Status Code 54 | 55 | - 200 - OK 56 | 57 | #### Response Body 58 | 59 | **@TODO** 60 | 61 | --- 62 | 63 | ## List Users History 64 | 65 | List user history. 66 | 67 | 68 | ### GET /api/session/data/{{data_source}}/history/users 69 | 70 | #### Headers 71 | 72 | None. 73 | 74 | #### Path Parameters 75 | 76 | - data_source (string, required) - Data source 77 | 78 | #### Query Parameters 79 | 80 | - token (string, required) - Auth Token 81 | - order (string, optional) - Property name to order 82 | 83 | #### Request Body 84 | 85 | None. 86 | 87 | ### Response 88 | 89 | #### Status Code 90 | 91 | - 200 - OK 92 | 93 | #### Response Body 94 | 95 | **@TODO** 96 | 97 | --- 98 | 99 | [Back to Top](#history) 100 | -------------------------------------------------------------------------------- /docs/AUTHENTICATION.md: -------------------------------------------------------------------------------- 1 | 2 | # Authentication 3 | 4 | Authentication allows you create and delete tokens. 5 | 6 | 7 | # Table of Contents 8 | 9 | - [Generate Token](#generate-token) 10 | - [Headers](#headers) 11 | - [Path Parameters](#path-parameters) 12 | - [Query Parameters](#query-parameters) 13 | - [Request Body](#request-body) 14 | - [Response](#response) 15 | - [Status Code](#status-code) 16 | - [Response Body](#response-body) 17 | - [Response Examples](#response-examples) 18 | - [Delete Token](#delete-token) 19 | - [Headers](#headers-1) 20 | - [Path Parameters](#path-parameters-1) 21 | - [Query Parameters](#query-parameters-1) 22 | - [Request Body](#request-body-1) 23 | - [Response](#response-1) 24 | - [Status Code](#status-code-1) 25 | - [Response Body](#response-body-1) 26 | 27 | ## Generate Token 28 | 29 | Generates token. 30 | 31 | 32 | ### POST /api/tokens 33 | 34 | #### Headers 35 | 36 | None. 37 | 38 | #### Path Parameters 39 | 40 | None. 41 | 42 | #### Query Parameters 43 | 44 | None. 45 | 46 | #### Request Body 47 | 48 | Body must be `x-www-form-urlencoded`. 49 | 50 | - username (string, required) - Name of the user. 51 | - password (string, required) - Password of the user. 52 | 53 | ``` 54 | username: guacadmin 55 | password: guacadmin 56 | ``` 57 | 58 | ### Response 59 | 60 | #### Status Code 61 | 62 | - 200 - OK 63 | 64 | #### Response Body 65 | 66 | Returns a JSON object. 67 | 68 | - authToken (string) - Auth token. 69 | - username (string) - Username. 70 | - dataSource (string) - Datasource. 71 | - availableDatasources (array) - List of available data sources. 72 | 73 | #### Response Examples 74 | 75 | ```json 76 | { 77 | "authToken": "0BDA2CED0580DEB052C34B596AB401993BFD66551FADEF06FC7144F1D6318EE8", 78 | "username": "guacadmin", 79 | "dataSource": "postgresql", 80 | "availableDataSources": ["postgresql", "postgresql-shared"] 81 | } 82 | ``` 83 | 84 | --- 85 | 86 | ## Delete Token 87 | 88 | Deletes token. 89 | 90 | 91 | ### DELETE /api/tokens/{{token}} 92 | 93 | #### Headers 94 | 95 | None. 96 | 97 | #### Path Parameters 98 | 99 | - token (string, required) - Auth Token 100 | 101 | #### Query Parameters 102 | 103 | None. 104 | 105 | #### Request Body 106 | 107 | None. 108 | 109 | ### Response 110 | 111 | #### Status Code 112 | 113 | - 204 - No Content 114 | 115 | #### Response Body 116 | 117 | This request does not return a response body. 118 | 119 | --- 120 | 121 | [Back to Top](#authentication) 122 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | 2 | # Guacamole Web REST API 3 | 4 | Guacamole REST API gives you access and manage Guacamole Web Application. 5 | 6 | [![Run in Postman](https://run.pstmn.io/button.svg)](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) 7 | 8 | 9 | ## Table of Contents 10 | 11 | - [Overview](#overview) 12 | - [Authentication](#authentication) 13 | - [Common Responses](#common-responses) 14 | - [Common Http Request Headers](#common-http-request-headers) 15 | - [Api Ref](#api-ref) 16 | 17 | # Overview 18 | 19 | This documentation is **unofficial** and based on **Guacamole version 1.1.0**. 20 | 21 | Keep in mind, it's not fully tested. 22 | 23 | # Authentication 24 | 25 | Authentication is required for all requests except the following: 26 | 27 | - Authentication 28 | - Languages 29 | - Patches 30 | 31 | Token must be named as 'token' and must be placed in request query. 32 | 33 | **Example:** `https://localhost/api/session/data/postgresql/connections?token=123456789` 34 | 35 | # Common Responses 36 | 37 | This section discusses various API responses. 38 | 39 | - 200 - A request succeeded. 40 | - 204 - No content 41 | - 400 - Bad request 42 | - 401 - Unauthorized 43 | - 404 - Not found 44 | 45 | # Common Http Request Headers 46 | 47 | The standard Http request headers that are used in requests. 48 | 49 | - Content-Type - The Internet media type of the request body. Used with POST, PUT and PATCH requests. Must be `application/json`. 50 | 51 | # Api Ref 52 | 53 | - [Authentication](https://github.com/ridvanaltun/guacamole-rest-api-documentation/blob/master/docs/AUTHENTICATION.md) 54 | - [Users](https://github.com/ridvanaltun/guacamole-rest-api-documentation/blob/master/docs/USERS.md) 55 | - [User Groups](https://github.com/ridvanaltun/guacamole-rest-api-documentation/blob/master/docs/USER-GROUPS.md) 56 | - [Connections](https://github.com/ridvanaltun/guacamole-rest-api-documentation/blob/master/docs/CONNECTIONS.md) 57 | - [Connection Groups](https://github.com/ridvanaltun/guacamole-rest-api-documentation/blob/master/docs/CONNECTION-GROUPS.md) 58 | - [Sharing Profiles](https://github.com/ridvanaltun/guacamole-rest-api-documentation/blob/master/docs/SHARING-PROFILES.md) 59 | - [Permissions](https://github.com/ridvanaltun/guacamole-rest-api-documentation/blob/master/docs/PERMISSIONS.md) 60 | - [History](https://github.com/ridvanaltun/guacamole-rest-api-documentation/blob/master/docs/HISTORY.md) 61 | - [Schemas](https://github.com/ridvanaltun/guacamole-rest-api-documentation/blob/master/docs/SCHEMAS.md) 62 | - [Tunnels](https://github.com/ridvanaltun/guacamole-rest-api-documentation/blob/master/docs/TUNNELS.md) 63 | - [Patches](https://github.com/ridvanaltun/guacamole-rest-api-documentation/blob/master/docs/PATCHES.md) 64 | - [Languages](https://github.com/ridvanaltun/guacamole-rest-api-documentation/blob/master/docs/LANGUAGES.md) 65 | -------------------------------------------------------------------------------- /docs/SHARING-PROFILES.md: -------------------------------------------------------------------------------- 1 | 2 | # Sharing Profiles 3 | 4 | Manage sharing profiles. 5 | 6 | 7 | # Table of Contents 8 | 9 | - [List Sharing Profiles](#list-sharing-profiles) 10 | - [Headers](#headers) 11 | - [Path Parameters](#path-parameters) 12 | - [Query Parameters](#query-parameters) 13 | - [Request Body](#request-body) 14 | - [Response](#response) 15 | - [Status Code](#status-code) 16 | - [Response Body](#response-body) 17 | - [Details of Sharing Profile](#details-of-sharing-profile) 18 | - [Headers](#headers-1) 19 | - [Path Parameters](#path-parameters-1) 20 | - [Query Parameters](#query-parameters-1) 21 | - [Request Body](#request-body-1) 22 | - [Response](#response-1) 23 | - [Status Code](#status-code-1) 24 | - [Response Body](#response-body-1) 25 | - [Create Sharing Profile](#create-sharing-profile) 26 | - [Headers](#headers-2) 27 | - [Path Parameters](#path-parameters-2) 28 | - [Query Parameters](#query-parameters-2) 29 | - [Request Body](#request-body-2) 30 | - [Response](#response-2) 31 | - [Status Code](#status-code-2) 32 | - [Response Body](#response-body-2) 33 | - [Delete Sharing Profile](#delete-sharing-profile) 34 | - [Headers](#headers-3) 35 | - [Path Parameters](#path-parameters-3) 36 | - [Query Parameters](#query-parameters-3) 37 | - [Request Body](#request-body-3) 38 | - [Response](#response-3) 39 | - [Status Code](#status-code-3) 40 | - [Response Body](#response-body-3) 41 | 42 | ## List Sharing Profiles 43 | 44 | 45 | ### GET /api/session/data/{{data_source}}/sharingProfiles 46 | 47 | #### Headers 48 | 49 | None. 50 | 51 | #### Path Parameters 52 | 53 | - data_source (string, required) - Data source 54 | 55 | #### Query Parameters 56 | 57 | - token (string, required) - Auth Token 58 | 59 | #### Request Body 60 | 61 | None. 62 | 63 | ### Response 64 | 65 | #### Status Code 66 | 67 | - 200 - OK 68 | 69 | #### Response Body 70 | 71 | **@TODO** 72 | 73 | --- 74 | 75 | ## Details of Sharing Profile 76 | 77 | Details of sharing profile. 78 | 79 | 80 | ### GET /api/session/data/{{data_source}}/sharingProfiles/{{sharing_profile}} 81 | 82 | #### Headers 83 | 84 | None. 85 | 86 | #### Path Parameters 87 | 88 | - data_source (string, required) - Data source 89 | - sharing_profile (string, required) - Sharing profile identifier 90 | 91 | #### Query Parameters 92 | 93 | - token (string, required) - Auth Token 94 | 95 | #### Request Body 96 | 97 | None. 98 | 99 | ### Response 100 | 101 | #### Status Code 102 | 103 | - 200 - OK 104 | 105 | #### Response Body 106 | 107 | **@TODO** 108 | 109 | --- 110 | 111 | ## Create Sharing Profile 112 | 113 | Create a sharing profile. 114 | 115 | 116 | ### POST /api/session/data/{{data_source}}/sharingProfiles 117 | 118 | #### Headers 119 | 120 | - Content-Type (string, required) - application/json 121 | 122 | #### Path Parameters 123 | 124 | - data_source (string, required) - Data source 125 | 126 | #### Query Parameters 127 | 128 | - token (string, required) - Auth Token 129 | 130 | #### Request Body 131 | 132 | **@TODO** 133 | 134 | ```json 135 | { 136 | "primaryConnectionIdentifier": "8", 137 | "name": "test", 138 | "parameters": { 139 | "read-only": "" 140 | }, 141 | "attributes": {} 142 | } 143 | ``` 144 | 145 | ### Response 146 | 147 | #### Status Code 148 | 149 | - 200 - OK 150 | 151 | #### Response Body 152 | 153 | **@TODO** 154 | 155 | --- 156 | 157 | ## Delete Sharing Profile 158 | 159 | Delete sharing profile. 160 | 161 | 162 | ### DELETE /api/session/data/{{data_source}}/sharingProfiles/{{sharing_profile}} 163 | 164 | #### Headers 165 | 166 | None. 167 | 168 | #### Path Parameters 169 | 170 | - data_source (string, required) - Data source 171 | - sharing_profile (string, required) - Sharing profile identifier 172 | 173 | #### Query Parameters 174 | 175 | - token (string, required) - Auth token 176 | 177 | #### Request Body 178 | 179 | None. 180 | 181 | ### Response 182 | 183 | #### Status Code 184 | 185 | - 204 - No Content 186 | 187 | #### Response Body 188 | 189 | This request does not return a response body. 190 | 191 | --- 192 | 193 | [Back to Top](#sharing-profiles) 194 | -------------------------------------------------------------------------------- /docs/SCHEMAS.md: -------------------------------------------------------------------------------- 1 | 2 | # Schemas 3 | 4 | Manage schemas. 5 | 6 | 7 | # Table of Contents 8 | 9 | - [List User Attributes Schema](#list-user-attributes-schema) 10 | - [Headers](#headers) 11 | - [Path Parameters](#path-parameters) 12 | - [Query Parameters](#query-parameters) 13 | - [Request Body](#request-body) 14 | - [Response](#response) 15 | - [Status Code](#status-code) 16 | - [Response Body](#response-body) 17 | - [List User Group Attributes Schema](#list-user-group-attributes-schema) 18 | - [Headers](#headers-1) 19 | - [Path Parameters](#path-parameters-1) 20 | - [Query Parameters](#query-parameters-1) 21 | - [Request Body](#request-body-1) 22 | - [Response](#response-1) 23 | - [Status Code](#status-code-1) 24 | - [Response Body](#response-body-1) 25 | - [List Connection Attributes Schema](#list-connection-attributes-schema) 26 | - [Headers](#headers-2) 27 | - [Path Parameters](#path-parameters-2) 28 | - [Query Parameters](#query-parameters-2) 29 | - [Request Body](#request-body-2) 30 | - [Response](#response-2) 31 | - [Status Code](#status-code-2) 32 | - [Response Body](#response-body-2) 33 | - [List Sharing Profile Attributes Schema](#list-sharing-profile-attributes-schema) 34 | - [Headers](#headers-3) 35 | - [Path Parameters](#path-parameters-3) 36 | - [Query Parameters](#query-parameters-3) 37 | - [Request Body](#request-body-3) 38 | - [Response](#response-3) 39 | - [Status Code](#status-code-3) 40 | - [Response Body](#response-body-3) 41 | - [List Connection Group Attributes Schema](#list-connection-group-attributes-schema) 42 | - [Headers](#headers-4) 43 | - [Path Parameters](#path-parameters-4) 44 | - [Query Parameters](#query-parameters-4) 45 | - [Request Body](#request-body-4) 46 | - [Response](#response-4) 47 | - [Status Code](#status-code-4) 48 | - [Response Body](#response-body-4) 49 | - [List Protocols](#list-protocols) 50 | - [Headers](#headers-5) 51 | - [Path Parameters](#path-parameters-5) 52 | - [Query Parameters](#query-parameters-5) 53 | - [Request Body](#request-body-5) 54 | - [Response](#response-5) 55 | - [Status Code](#status-code-5) 56 | - [Response Body](#response-body-5) 57 | 58 | ## List User Attributes Schema 59 | 60 | List user attributes schema. 61 | 62 | 63 | ### GET /api/session/data/{{data_source}}/schema/userAttributes 64 | 65 | #### Headers 66 | 67 | None. 68 | 69 | #### Path Parameters 70 | 71 | - data_source (string, required) - Data source 72 | 73 | #### Query Parameters 74 | 75 | - token (string, required) - Auth Token 76 | 77 | #### Request Body 78 | 79 | None. 80 | 81 | ### Response 82 | 83 | #### Status Code 84 | 85 | - 200 - OK 86 | 87 | #### Response Body 88 | 89 | **@TODO** 90 | 91 | --- 92 | 93 | ## List User Group Attributes Schema 94 | 95 | List user group attributes schema. 96 | 97 | 98 | ### GET /api/session/data/{{data_source}}/schema/userGroupAttributes 99 | 100 | #### Headers 101 | 102 | None. 103 | 104 | #### Path Parameters 105 | 106 | - data_source (string, required) - Data source 107 | 108 | #### Query Parameters 109 | 110 | - token (string, required) - Auth Token 111 | 112 | #### Request Body 113 | 114 | None. 115 | 116 | ### Response 117 | 118 | #### Status Code 119 | 120 | - 200 - OK 121 | 122 | #### Response Body 123 | 124 | **@TODO** 125 | 126 | --- 127 | 128 | ## List Connection Attributes Schema 129 | 130 | List connection attributes schema. 131 | 132 | 133 | ### GET /api/session/data/{{data_source}}/schema/connectionAttributes 134 | 135 | #### Headers 136 | 137 | None. 138 | 139 | #### Path Parameters 140 | 141 | - data_source (string, required) - Data source 142 | 143 | #### Query Parameters 144 | 145 | - token (string, required) - Auth Token 146 | 147 | #### Request Body 148 | 149 | None. 150 | 151 | ### Response 152 | 153 | #### Status Code 154 | 155 | - 200 - OK 156 | 157 | #### Response Body 158 | 159 | **@TODO** 160 | 161 | --- 162 | 163 | ## List Sharing Profile Attributes Schema 164 | 165 | List sharing profile attributes schema. 166 | 167 | 168 | ### GET /api/session/data/{{data_source}}/schema/sharingProfileAttributes 169 | 170 | #### Headers 171 | 172 | None. 173 | 174 | #### Path Parameters 175 | 176 | - data_source (string, required) - Data source 177 | 178 | #### Query Parameters 179 | 180 | - token (string, required) - Auth Token 181 | 182 | #### Request Body 183 | 184 | None. 185 | 186 | ### Response 187 | 188 | #### Status Code 189 | 190 | - 200 - OK 191 | 192 | #### Response Body 193 | 194 | **@TODO** 195 | 196 | --- 197 | 198 | ## List Connection Group Attributes Schema 199 | 200 | List connection group attributes schema. 201 | 202 | 203 | ### GET /api/session/data/{{data_source}}/schema/connectionGroupAttributes 204 | 205 | #### Headers 206 | 207 | None. 208 | 209 | #### Path Parameters 210 | 211 | - data_source (string, required) - Data source 212 | 213 | #### Query Parameters 214 | 215 | - token (string, required) - Auth Token 216 | 217 | #### Request Body 218 | 219 | None. 220 | 221 | ### Response 222 | 223 | #### Status Code 224 | 225 | - 200 - OK 226 | 227 | #### Response Body 228 | 229 | **@TODO** 230 | 231 | --- 232 | 233 | ## List Protocols 234 | 235 | List protocols. 236 | 237 | 238 | ### GET /api/session/data/{{data_source}}/schema/protocols 239 | 240 | #### Headers 241 | 242 | None. 243 | 244 | #### Path Parameters 245 | 246 | - data_source (string, required) - Data source 247 | 248 | #### Query Parameters 249 | 250 | - token (string, required) - Auth Token 251 | 252 | #### Request Body 253 | 254 | None. 255 | 256 | ### Response 257 | 258 | #### Status Code 259 | 260 | - 200 - OK 261 | 262 | #### Response Body 263 | 264 | **@TODO** 265 | 266 | --- 267 | 268 | [Back to Top](#schemas) 269 | -------------------------------------------------------------------------------- /docs/CONNECTION-GROUPS.md: -------------------------------------------------------------------------------- 1 | 2 | # Connection Groups 3 | 4 | Manage connection groups. 5 | 6 | 7 | # Table of Contents 8 | 9 | - [List Connection Groups](#list-connection-groups) 10 | - [Headers](#headers) 11 | - [Path Parameters](#path-parameters) 12 | - [Query Parameters](#query-parameters) 13 | - [Request Body](#request-body) 14 | - [Response](#response) 15 | - [Status Code](#status-code) 16 | - [Response Body](#response-body) 17 | - [List Connections and Connection Groups](#list-connections-and-connection-groups) 18 | - [Headers](#headers-1) 19 | - [Path Parameters](#path-parameters-1) 20 | - [Query Parameters](#query-parameters-1) 21 | - [Request Body](#request-body-1) 22 | - [Response](#response-1) 23 | - [Status Code](#status-code-1) 24 | - [Response Body](#response-body-1) 25 | - [Details of Connection Group](#details-of-connection-group) 26 | - [Headers](#headers-2) 27 | - [Path Parameters](#path-parameters-2) 28 | - [Query Parameters](#query-parameters-2) 29 | - [Request Body](#request-body-2) 30 | - [Response](#response-2) 31 | - [Status Code](#status-code-2) 32 | - [Response Body](#response-body-2) 33 | - [Details of Connection Group Tree](#details-of-connection-group-tree) 34 | - [Headers](#headers-3) 35 | - [Path Parameters](#path-parameters-3) 36 | - [Query Parameters](#query-parameters-3) 37 | - [Request Body](#request-body-3) 38 | - [Response](#response-3) 39 | - [Status Code](#status-code-3) 40 | - [Response Body](#response-body-3) 41 | - [Update Connection Group](#update-connection-group) 42 | - [Headers](#headers-4) 43 | - [Path Parameters](#path-parameters-4) 44 | - [Query Parameters](#query-parameters-4) 45 | - [Request Body](#request-body-4) 46 | - [Response](#response-4) 47 | - [Status Code](#status-code-4) 48 | - [Response Body](#response-body-4) 49 | - [Create Connection Group](#create-connection-group) 50 | - [Headers](#headers-5) 51 | - [Path Parameters](#path-parameters-5) 52 | - [Query Parameters](#query-parameters-5) 53 | - [Request Body](#request-body-5) 54 | - [Response](#response-5) 55 | - [Status Code](#status-code-5) 56 | - [Response Body](#response-body-5) 57 | - [Delete Connection Group](#delete-connection-group) 58 | - [Headers](#headers-6) 59 | - [Path Parameters](#path-parameters-6) 60 | - [Query Parameters](#query-parameters-6) 61 | - [Request Body](#request-body-6) 62 | - [Response](#response-6) 63 | - [Status Code](#status-code-6) 64 | - [Response Body](#response-body-6) 65 | 66 | ## List Connection Groups 67 | 68 | List connection groups. 69 | 70 | 71 | ### GET /api/session/data/{{data_source}}/connectionGroups 72 | 73 | #### Headers 74 | 75 | None. 76 | 77 | #### Path Parameters 78 | 79 | - data_source (string, required) - Data source 80 | 81 | #### Query Parameters 82 | 83 | - token (string, required) - Auth Token 84 | 85 | #### Request Body 86 | 87 | None. 88 | 89 | ### Response 90 | 91 | #### Status Code 92 | 93 | - 200 - OK 94 | 95 | #### Response Body 96 | 97 | **@TODO** 98 | 99 | --- 100 | 101 | ## List Connections and Connection Groups 102 | 103 | List connection groups with connections. 104 | 105 | 106 | ### GET /api/session/data/{{data_source}}/connectionGroups/ROOT/tree 107 | 108 | #### Headers 109 | 110 | None. 111 | 112 | #### Path Parameters 113 | 114 | - data_source (string, required) - Data source 115 | 116 | #### Query Parameters 117 | 118 | - token (string, required) - Auth Token 119 | 120 | #### Request Body 121 | 122 | None. 123 | 124 | ### Response 125 | 126 | #### Status Code 127 | 128 | - 200 - OK 129 | 130 | #### Response Body 131 | 132 | **@TODO** 133 | 134 | --- 135 | 136 | ## Details of Connection Group 137 | 138 | Details of connection group. 139 | 140 | 141 | ### GET /api/session/data/{{data_source}}/connectionGroups/{{connection_group}} 142 | 143 | #### Headers 144 | 145 | None. 146 | 147 | #### Path Parameters 148 | 149 | - data_source (string, required) - Data source 150 | - connection_group (integer, required) - Connection group identifier 151 | 152 | #### Query Parameters 153 | 154 | - token (string, required) - Auth Token 155 | 156 | #### Request Body 157 | 158 | None. 159 | 160 | ### Response 161 | 162 | #### Status Code 163 | 164 | - 200 - OK 165 | 166 | #### Response Body 167 | 168 | **@TODO** 169 | 170 | --- 171 | 172 | ## Details of Connection Group Tree 173 | 174 | Details of connection group tree. 175 | 176 | 177 | ### GET /api/session/data/{{data_source}}/connectionGroups/{{connection_group}}/tree 178 | 179 | #### Headers 180 | 181 | None. 182 | 183 | #### Path Parameters 184 | 185 | - data_source (string, required) - Data source 186 | - connection_group (integer, required) - Connection group identifier 187 | 188 | #### Query Parameters 189 | 190 | - token (string, required) - Auth Token 191 | - permission (string, optional) - Permission 192 | 193 | #### Request Body 194 | 195 | None. 196 | 197 | ### Response 198 | 199 | #### Status Code 200 | 201 | - 200 - OK 202 | 203 | #### Response Body 204 | 205 | **@TODO** 206 | 207 | --- 208 | 209 | ## Update Connection Group 210 | 211 | Updates connection group. 212 | 213 | 214 | ### PUT /api/session/data/{{data_source}}/connectionGroups/{{connection_group}} 215 | 216 | #### Headers 217 | 218 | - Content-Type (string, required) - application/json 219 | 220 | #### Path Parameters 221 | 222 | - data_source (string, required) - Data source 223 | - connection_group (integer, required) - Connection group identifier 224 | 225 | #### Query Parameters 226 | 227 | - token (string, required) - Auth Token 228 | 229 | #### Request Body 230 | 231 | **@TODO** 232 | 233 | ```json 234 | { 235 | "name": "test", 236 | "identifier": "1", 237 | "parentIdentifier": "ROOT", 238 | "type": "ORGANIZATIONAL", 239 | "activeConnections": 0, 240 | "attributes": { 241 | "max-connections": "", 242 | "max-connections-per-user": "", 243 | "enable-session-affinity": "" 244 | } 245 | } 246 | ``` 247 | 248 | ### Response 249 | 250 | #### Status Code 251 | 252 | - 204 - No Content 253 | 254 | #### Response Body 255 | 256 | This request does not return a response body. 257 | 258 | --- 259 | 260 | ## Create Connection Group 261 | 262 | Creates connection group. 263 | 264 | 265 | ### POST /api/session/data/{{data_source}}/connectionGroups 266 | 267 | #### Headers 268 | 269 | - Content-Type (string, required) - application/json 270 | 271 | #### Path Parameters 272 | 273 | - data_source (string, required) - Data source 274 | 275 | #### Query Parameters 276 | 277 | - token (string, required) - Auth Token 278 | 279 | #### Request Body 280 | 281 | **@TODO** 282 | 283 | ```json 284 | { 285 | "parentIdentifier": "1", 286 | "name": "name", 287 | "type": "ORGANIZATIONAL", 288 | "attributes": { 289 | "max-connections": "", 290 | "max-connections-per-user": "", 291 | "enable-session-affinity": "" 292 | } 293 | } 294 | ``` 295 | 296 | ### Response 297 | 298 | #### Status Code 299 | 300 | - 200 - OK 301 | 302 | #### Response Body 303 | 304 | **@TODO** 305 | 306 | --- 307 | 308 | ## Delete Connection Group 309 | 310 | Delete connection group. 311 | 312 | 313 | ### DELETE /api/session/data/{{data_source}}/connectionGroups/{{connection_group}} 314 | 315 | #### Headers 316 | 317 | None. 318 | 319 | #### Path Parameters 320 | 321 | - data_source (string, required) - Data source 322 | - connection_group (string, required) - Connection groups identifier 323 | 324 | #### Query Parameters 325 | 326 | - token (string, required) - Auth token 327 | 328 | #### Request Body 329 | 330 | None. 331 | 332 | ### Response 333 | 334 | #### Status Code 335 | 336 | - 204 - No Content 337 | 338 | #### Response Body 339 | 340 | This request does not return a response body. 341 | 342 | --- 343 | 344 | [Back to Top](#connection-groups) 345 | -------------------------------------------------------------------------------- /docs/PERMISSIONS.md: -------------------------------------------------------------------------------- 1 | 2 | # Permissions 3 | 4 | Manage permissions. 5 | 6 | 7 | # Table of Contents 8 | 9 | - [Assign System Permissions to User](#assign-system-permissions-to-user) 10 | - [Headers](#headers) 11 | - [Path Parameters](#path-parameters) 12 | - [Query Parameters](#query-parameters) 13 | - [Request Body](#request-body) 14 | - [Response](#response) 15 | - [Status Code](#status-code) 16 | - [Response Body](#response-body) 17 | - [Revoke System Permissions from User](#revoke-system-permissions-from-user) 18 | - [Headers](#headers-1) 19 | - [Path Parameters](#path-parameters-1) 20 | - [Query Parameters](#query-parameters-1) 21 | - [Request Body](#request-body-1) 22 | - [Response](#response-1) 23 | - [Status Code](#status-code-1) 24 | - [Response Body](#response-body-1) 25 | - [Assign Connection Groups to User](#assign-connection-groups-to-user) 26 | - [Headers](#headers-2) 27 | - [Path Parameters](#path-parameters-2) 28 | - [Query Parameters](#query-parameters-2) 29 | - [Request Body](#request-body-2) 30 | - [Response](#response-2) 31 | - [Status Code](#status-code-2) 32 | - [Response Body](#response-body-2) 33 | - [Revoke Connection Group from User](#revoke-connection-group-from-user) 34 | - [Headers](#headers-3) 35 | - [Path Parameters](#path-parameters-3) 36 | - [Query Parameters](#query-parameters-3) 37 | - [Request Body](#request-body-3) 38 | - [Response](#response-3) 39 | - [Status Code](#status-code-3) 40 | - [Response Body](#response-body-3) 41 | - [Assign Connection Groups to User Group](#assign-connection-groups-to-user-group) 42 | - [Headers](#headers-4) 43 | - [Path Parameters](#path-parameters-4) 44 | - [Query Parameters](#query-parameters-4) 45 | - [Request Body](#request-body-4) 46 | - [Response](#response-4) 47 | - [Status Code](#status-code-4) 48 | - [Response Body](#response-body-4) 49 | - [Revoke Connection Group from User Group](#revoke-connection-group-from-user-group) 50 | - [Headers](#headers-5) 51 | - [Path Parameters](#path-parameters-5) 52 | - [Query Parameters](#query-parameters-5) 53 | - [Request Body](#request-body-5) 54 | - [Response](#response-5) 55 | - [Status Code](#status-code-5) 56 | - [Response Body](#response-body-5) 57 | 58 | ## Assign System Permissions to User 59 | 60 | Assign system permissions to an user. 61 | 62 | 63 | ### PATCH /api/session/data/{{data_source}}/users/{{username}}/permissions 64 | 65 | #### Headers 66 | 67 | - Content-Type (string, required) - application/json 68 | 69 | #### Path Parameters 70 | 71 | - data_source (string, required) - Data source 72 | - username (string, required) - Username 73 | 74 | #### Query Parameters 75 | 76 | - token (string, required) - Auth token 77 | 78 | #### Request Body 79 | 80 | Body must be [json-patch](http://jsonpatch.com/) format. 81 | 82 | ```json 83 | [ 84 | { 85 | "op": "add", 86 | "path": "/userPermissions/test1", 87 | "value": "UPDATE" 88 | }, 89 | { 90 | "op": "add", 91 | "path": "/systemPermissions", 92 | "value": "CREATE_USER" 93 | }, 94 | { 95 | "op": "add", 96 | "path": "/systemPermissions", 97 | "value": "CREATE_USER_GROUP" 98 | }, 99 | { 100 | "op": "add", 101 | "path": "/systemPermissions", 102 | "value": "CREATE_CONNECTION" 103 | }, 104 | { 105 | "op": "add", 106 | "path": "/systemPermissions", 107 | "value": "CREATE_CONNECTION_GROUP" 108 | }, 109 | { 110 | "op": "add", 111 | "path": "/systemPermissions", 112 | "value": "CREATE_SHARING_PROFILE" 113 | }, 114 | { 115 | "op": "add", 116 | "path": "/systemPermissions", 117 | "value": "ADMINISTER" 118 | } 119 | ] 120 | ``` 121 | 122 | ### Response 123 | 124 | #### Status Code 125 | 126 | - 204 - No Content 127 | 128 | #### Response Body 129 | 130 | This request does not return a response body. 131 | 132 | --- 133 | 134 | ## Revoke System Permissions from User 135 | 136 | Revoke system permissions from an user. 137 | 138 | 139 | ### PATCH /api/session/data/{{data_source}}/users/{{username}}/permissions 140 | 141 | #### Headers 142 | 143 | - Content-Type (string, required) - application/json 144 | 145 | #### Path Parameters 146 | 147 | - data_source (string, required) - Data source 148 | - username (string, required) - Username 149 | 150 | #### Query Parameters 151 | 152 | - token (string, required) - Auth Token 153 | 154 | #### Request Body 155 | 156 | Body must be [json-patch](http://jsonpatch.com/) format. 157 | 158 | ```json 159 | [ 160 | { 161 | "op": "remove", 162 | "path": "/userPermissions/test1", 163 | "value": "UPDATE" 164 | }, 165 | { 166 | "op": "remove", 167 | "path": "/systemPermissions", 168 | "value": "CREATE_SHARING_PROFILE" 169 | }, 170 | { 171 | "op": "remove", 172 | "path": "/systemPermissions", 173 | "value": "CREATE_CONNECTION_GROUP" 174 | }, 175 | { 176 | "op": "remove", 177 | "path": "/systemPermissions", 178 | "value": "CREATE_CONNECTION" 179 | }, 180 | { 181 | "op": "remove", 182 | "path": "/systemPermissions", 183 | "value": "CREATE_USER_GROUP" 184 | }, 185 | { 186 | "op": "remove", 187 | "path": "/systemPermissions", 188 | "value": "CREATE_USER" 189 | }, 190 | { 191 | "op": "remove", 192 | "path": "/systemPermissions", 193 | "value": "ADMINISTER" 194 | } 195 | ] 196 | ``` 197 | 198 | ### Response 199 | 200 | #### Status Code 201 | 202 | - 204 - No Content 203 | 204 | #### Response Body 205 | 206 | This request does not return a response body. 207 | 208 | --- 209 | 210 | ## Assign Connection Groups to User 211 | 212 | Assign connection groups to an user. 213 | 214 | 215 | ### PATCH /api/session/data/{{data_source}}/users/{{username}}/permissions 216 | 217 | #### Headers 218 | 219 | - Content-Type (string, required) - application/json 220 | 221 | #### Path Parameters 222 | 223 | - data_source (string, required) - Data source 224 | - username (string, required) - Username 225 | 226 | #### Query Parameters 227 | 228 | - token (string, required) - Auth Token 229 | 230 | #### Request Body 231 | 232 | Body must be [json-patch](http://jsonpatch.com/) format. 233 | 234 | ```json 235 | [ 236 | { 237 | "op": "add", 238 | "path": "/connectionGroupPermissions/{{connection_group}}", 239 | "value": "READ" 240 | } 241 | ] 242 | ``` 243 | 244 | ### Response 245 | 246 | #### Status Code 247 | 248 | - 204 - No Content 249 | 250 | #### Response Body 251 | 252 | This request does not return a response body. 253 | 254 | --- 255 | 256 | ## Revoke Connection Group from User 257 | 258 | Revoke connection groups from an user. 259 | 260 | 261 | ### PATCH /api/session/data/{{data_source}}/users/{{username}}/permissions 262 | 263 | #### Headers 264 | 265 | - Content-Type (string, required) - application/json 266 | 267 | #### Path Parameters 268 | 269 | - data_source (string, required) - Data source 270 | - username (string, required) - Username 271 | 272 | #### Query Parameters 273 | 274 | - token (string, required) - Auth Token 275 | 276 | #### Request Body 277 | 278 | Body must be [json-patch](http://jsonpatch.com/) format. 279 | 280 | ```json 281 | [ 282 | { 283 | "op": "remove", 284 | "path": "/connectionGroupPermissions/{{connection_group}}", 285 | "value": "READ" 286 | } 287 | ] 288 | ``` 289 | 290 | ### Response 291 | 292 | #### Status Code 293 | 294 | - 204 - No Content 295 | 296 | #### Response Body 297 | 298 | This request does not return a response body. 299 | 300 | --- 301 | 302 | ## Assign Connection Groups to User Group 303 | 304 | Assign connection groups to an user group. 305 | 306 | 307 | ### PATCH /api/session/data/{{data_source}}/userGroups/{{user_group}}/permissions 308 | 309 | #### Headers 310 | 311 | - Content-Type (string, required) - application/json 312 | 313 | #### Path Parameters 314 | 315 | - data_source (string, required) - Data source 316 | - user_group (string, required) - User group identifier 317 | 318 | #### Query Parameters 319 | 320 | - token (string, required) - Auth Token 321 | 322 | #### Request Body 323 | 324 | Body must be [json-patch](http://jsonpatch.com/) format. 325 | 326 | ```json 327 | [ 328 | { 329 | "op": "add", 330 | "path": "/connectionGroupPermissions/{{connection_group}}", 331 | "value": "READ" 332 | } 333 | ] 334 | ``` 335 | 336 | ### Response 337 | 338 | #### Status Code 339 | 340 | - 204 - No Content 341 | 342 | #### Response Body 343 | 344 | This request does not return a response body. 345 | 346 | --- 347 | 348 | ## Revoke Connection Group from User Group 349 | 350 | Revoke connection groups from an user group. 351 | 352 | 353 | ### PATCH /api/session/data/{{data_source}}/userGroups/{{user_group}}/permissions 354 | 355 | #### Headers 356 | 357 | - Content-Type (string, required) - application/json 358 | 359 | #### Path Parameters 360 | 361 | - data_source (string, required) - Data source 362 | - user_group (string, required) - User group identifier 363 | 364 | #### Query Parameters 365 | 366 | - token (string, required) - Auth Token 367 | 368 | #### Request Body 369 | 370 | Body must be [json-patch](http://jsonpatch.com/) format. 371 | 372 | ```json 373 | [ 374 | { 375 | "op": "remove", 376 | "path": "/connectionGroupPermissions/{{connection_group}}", 377 | "value": "READ" 378 | } 379 | ] 380 | ``` 381 | 382 | ### Response 383 | 384 | #### Status Code 385 | 386 | - 204 - No Content 387 | 388 | #### Response Body 389 | 390 | This request does not return a response body. 391 | 392 | --- 393 | 394 | [Back to Top](#permissions) 395 | -------------------------------------------------------------------------------- /docs/USER-GROUPS.md: -------------------------------------------------------------------------------- 1 | 2 | # User Groups 3 | 4 | Manage user groups. 5 | 6 | 7 | # Table of Contents 8 | 9 | - [List User Groups](#list-user-groups) 10 | - [Headers](#headers) 11 | - [Path Parameters](#path-parameters) 12 | - [Query Parameters](#query-parameters) 13 | - [Request Body](#request-body) 14 | - [Response](#response) 15 | - [Status Code](#status-code) 16 | - [Response Body](#response-body) 17 | - [Details of User Group](#details-of-user-group) 18 | - [Headers](#headers-1) 19 | - [Path Parameters](#path-parameters-1) 20 | - [Query Parameters](#query-parameters-1) 21 | - [Request Body](#request-body-1) 22 | - [Response](#response-1) 23 | - [Status Code](#status-code-1) 24 | - [Response Body](#response-body-1) 25 | - [Add Members to User Group](#add-members-to-user-group) 26 | - [Headers](#headers-2) 27 | - [Path Parameters](#path-parameters-2) 28 | - [Query Parameters](#query-parameters-2) 29 | - [Request Body](#request-body-2) 30 | - [Response](#response-2) 31 | - [Status Code](#status-code-2) 32 | - [Response Body](#response-body-2) 33 | - [Add Member Groups to User Group](#add-member-groups-to-user-group) 34 | - [Headers](#headers-3) 35 | - [Path Parameters](#path-parameters-3) 36 | - [Query Parameters](#query-parameters-3) 37 | - [Request Body](#request-body-3) 38 | - [Response](#response-3) 39 | - [Status Code](#status-code-3) 40 | - [Response Body](#response-body-3) 41 | - [Add Parent Groups to User Group](#add-parent-groups-to-user-group) 42 | - [Headers](#headers-4) 43 | - [Path Parameters](#path-parameters-4) 44 | - [Query Parameters](#query-parameters-4) 45 | - [Request Body](#request-body-4) 46 | - [Response](#response-4) 47 | - [Status Code](#status-code-4) 48 | - [Response Body](#response-body-4) 49 | - [Assign Permissions to User Group](#assign-permissions-to-user-group) 50 | - [Headers](#headers-5) 51 | - [Path Parameters](#path-parameters-5) 52 | - [Query Parameters](#query-parameters-5) 53 | - [Request Body](#request-body-5) 54 | - [Response](#response-5) 55 | - [Status Code](#status-code-5) 56 | - [Response Body](#response-body-5) 57 | - [Revoke Permissions from User Group](#revoke-permissions-from-user-group) 58 | - [Headers](#headers-6) 59 | - [Path Parameters](#path-parameters-6) 60 | - [Query Parameters](#query-parameters-6) 61 | - [Request Body](#request-body-6) 62 | - [Response](#response-6) 63 | - [Status Code](#status-code-6) 64 | - [Response Body](#response-body-6) 65 | - [Assign Connections to User Group](#assign-connections-to-user-group) 66 | - [Headers](#headers-7) 67 | - [Path Parameters](#path-parameters-7) 68 | - [Query Parameters](#query-parameters-7) 69 | - [Request Body](#request-body-7) 70 | - [Response](#response-7) 71 | - [Status Code](#status-code-7) 72 | - [Response Body](#response-body-7) 73 | - [Revoke Connections from User Group](#revoke-connections-from-user-group) 74 | - [Headers](#headers-8) 75 | - [Path Parameters](#path-parameters-8) 76 | - [Query Parameters](#query-parameters-8) 77 | - [Request Body](#request-body-8) 78 | - [Response](#response-8) 79 | - [Status Code](#status-code-8) 80 | - [Response Body](#response-body-8) 81 | - [Update User Group](#update-user-group) 82 | - [Headers](#headers-9) 83 | - [Path Parameters](#path-parameters-9) 84 | - [Query Parameters](#query-parameters-9) 85 | - [Request Body](#request-body-9) 86 | - [Response](#response-9) 87 | - [Status Code](#status-code-9) 88 | - [Response Body](#response-body-9) 89 | - [Create User Group](#create-user-group) 90 | - [Headers](#headers-10) 91 | - [Path Parameters](#path-parameters-10) 92 | - [Query Parameters](#query-parameters-10) 93 | - [Request Body](#request-body-10) 94 | - [Response](#response-10) 95 | - [Status Code](#status-code-10) 96 | - [Response Body](#response-body-10) 97 | - [Delete User Group](#delete-user-group) 98 | - [Headers](#headers-11) 99 | - [Path Parameters](#path-parameters-11) 100 | - [Query Parameters](#query-parameters-11) 101 | - [Request Body](#request-body-11) 102 | - [Response](#response-11) 103 | - [Status Code](#status-code-11) 104 | - [Response Body](#response-body-11) 105 | 106 | ## List User Groups 107 | 108 | 109 | ### GET /api/session/data/{{data_source}}/userGroups 110 | 111 | #### Headers 112 | 113 | None. 114 | 115 | #### Path Parameters 116 | 117 | - data_source (string, required) - Data source 118 | 119 | #### Query Parameters 120 | 121 | - token (string, required) - Auth Token 122 | 123 | #### Request Body 124 | 125 | None. 126 | 127 | ### Response 128 | 129 | #### Status Code 130 | 131 | - 200 - OK 132 | 133 | #### Response Body 134 | 135 | **@TODO** 136 | 137 | --- 138 | 139 | ## Details of User Group 140 | 141 | 142 | ### GET /api/session/data/{{data_source}}/userGroups/{{user_group}} 143 | 144 | #### Headers 145 | 146 | None. 147 | 148 | #### Path Parameters 149 | 150 | - data_source (string, required) - Data source 151 | - user_group (string, required) - User group identifier 152 | 153 | #### Query Parameters 154 | 155 | - token (string, required) - Auth Token 156 | 157 | #### Request Body 158 | 159 | None. 160 | 161 | ### Response 162 | 163 | #### Status Code 164 | 165 | - 200 - OK 166 | 167 | #### Response Body 168 | 169 | **@TODO** 170 | 171 | --- 172 | 173 | ## Add Members to User Group 174 | 175 | Add members to an user group. 176 | 177 | 178 | ### PATCH /api/session/data/{{data_source}}/userGroups/{{user_group}}/memberUsers 179 | 180 | #### Headers 181 | 182 | - Content-Type (string, required) - application/json 183 | 184 | #### Path Parameters 185 | 186 | - data_source (string, required) - Data source 187 | - user_group (string, required) - User group identifier 188 | 189 | #### Query Parameters 190 | 191 | - token (string, required) - Auth Token 192 | 193 | #### Request Body 194 | 195 | Body must be [json-patch](http://jsonpatch.com/) format. 196 | 197 | ```json 198 | [ 199 | { 200 | "op": "add", 201 | "path": "/", 202 | "value": "{{username}}" 203 | } 204 | ] 205 | ``` 206 | 207 | ### Response 208 | 209 | #### Status Code 210 | 211 | - 204 - No Content 212 | 213 | #### Response Body 214 | 215 | This request does not return a response body. 216 | 217 | --- 218 | 219 | ## Add Member Groups to User Group 220 | 221 | Add member groups to an user group. 222 | 223 | 224 | ### PATCH /api/session/data/{{data_source}}/userGroups/{{user_group}}/memberUserGroups 225 | 226 | #### Headers 227 | 228 | - Content-Type (string, required) - application/json 229 | 230 | #### Path Parameters 231 | 232 | - data_source (string, required) - Data source 233 | - user_group (string, required) - User group identifier 234 | 235 | #### Query Parameters 236 | 237 | - token (string, required) - Auth Token 238 | 239 | #### Request Body 240 | 241 | Body must be [json-patch](http://jsonpatch.com/) format. 242 | 243 | ```json 244 | [ 245 | { 246 | "op": "add", 247 | "path": "/", 248 | "value": "{{userGroupIdentifier}}" 249 | } 250 | ] 251 | ``` 252 | 253 | ### Response 254 | 255 | #### Status Code 256 | 257 | - 204 - No Content 258 | 259 | #### Response Body 260 | 261 | This request does not return a response body. 262 | 263 | --- 264 | 265 | ## Add Parent Groups to User Group 266 | 267 | Add parent groups to an user group. 268 | 269 | 270 | ### PATCH /api/session/data/{{data_source}}/userGroups/{{user_group}}/userGroups 271 | 272 | #### Headers 273 | 274 | - Content-Type (string, required) - application/json 275 | 276 | #### Path Parameters 277 | 278 | - data_source (string, required) - Data source 279 | - user_group (string, required) - User group identifier 280 | 281 | #### Query Parameters 282 | 283 | - token (string, required) - Auth Token 284 | 285 | #### Request Body 286 | 287 | Body must be [json-patch](http://jsonpatch.com/) format. 288 | 289 | ```json 290 | [ 291 | { 292 | "op": "add", 293 | "path": "/", 294 | "value": "{{userGroupIdentifier}}" 295 | } 296 | ] 297 | ``` 298 | 299 | ### Response 300 | 301 | #### Status Code 302 | 303 | - 204 - No Content 304 | 305 | #### Response Body 306 | 307 | This request does not return a response body. 308 | 309 | --- 310 | 311 | ## Assign Permissions to User Group 312 | 313 | Assign permissions to an user group. 314 | 315 | 316 | ### PATCH /api/session/data/{{data_source}}/userGroups/{{user_group}}/permissions 317 | 318 | #### Headers 319 | 320 | - Content-Type (string, required) - application/json 321 | 322 | #### Path Parameters 323 | 324 | - data_source (string, required) - Data source 325 | - user_group (string, required) - User group identifier 326 | 327 | #### Query Parameters 328 | 329 | - token (string, required) - Auth Token 330 | 331 | #### Request Body 332 | 333 | Body must be [json-patch](http://jsonpatch.com/) format. 334 | 335 | ```json 336 | [ 337 | { 338 | "op": "add", 339 | "path": "/connectionPermissions/{{user_group}}", 340 | "value": "READ" 341 | }, 342 | { 343 | "op": "add", 344 | "path": "/systemPermissions", 345 | "value": "CREATE_USER" 346 | }, 347 | { 348 | "op": "add", 349 | "path": "/systemPermissions", 350 | "value": "ADMINISTER" 351 | }, 352 | { 353 | "op": "add", 354 | "path": "/systemPermissions", 355 | "value": "CREATE_USER_GROUP" 356 | }, 357 | { 358 | "op": "add", 359 | "path": "/systemPermissions", 360 | "value": "CREATE_CONNECTION" 361 | }, 362 | { 363 | "op": "add", 364 | "path": "/systemPermissions", 365 | "value": "CREATE_SHARING_PROFILE" 366 | }, 367 | { 368 | "op": "add", 369 | "path": "/systemPermissions", 370 | "value": "CREATE_CONNECTION_GROUP" 371 | } 372 | ] 373 | ``` 374 | 375 | ### Response 376 | 377 | #### Status Code 378 | 379 | - 204 - No Content 380 | 381 | #### Response Body 382 | 383 | This request does not return a response body. 384 | 385 | --- 386 | 387 | ## Revoke Permissions from User Group 388 | 389 | Revoke permissions from an user group. 390 | 391 | 392 | ### PATCH /api/session/data/{{data_source}}/userGroups/{{user_group}}/permissions 393 | 394 | #### Headers 395 | 396 | - Content-Type (string, required) - application/json 397 | 398 | #### Path Parameters 399 | 400 | - data_source (string, required) - Data source 401 | - user_group (string, required) - User group identifier 402 | 403 | #### Query Parameters 404 | 405 | - token (string, required) - Auth Token 406 | 407 | #### Request Body 408 | 409 | Body must be [json-patch](http://jsonpatch.com/) format. 410 | 411 | ```json 412 | [ 413 | { 414 | "op": "remove", 415 | "path": "/connectionPermissions/{{user_group}}", 416 | "value": "READ" 417 | }, 418 | { 419 | "op": "remove", 420 | "path": "/systemPermissions", 421 | "value": "CREATE_USER" 422 | }, 423 | { 424 | "op": "remove", 425 | "path": "/systemPermissions", 426 | "value": "ADMINISTER" 427 | }, 428 | { 429 | "op": "remove", 430 | "path": "/systemPermissions", 431 | "value": "CREATE_USER_GROUP" 432 | }, 433 | { 434 | "op": "remove", 435 | "path": "/systemPermissions", 436 | "value": "CREATE_CONNECTION" 437 | }, 438 | { 439 | "op": "remove", 440 | "path": "/systemPermissions", 441 | "value": "CREATE_SHARING_PROFILE" 442 | }, 443 | { 444 | "op": "remove", 445 | "path": "/systemPermissions", 446 | "value": "CREATE_CONNECTION_GROUP" 447 | } 448 | ] 449 | ``` 450 | 451 | ### Response 452 | 453 | #### Status Code 454 | 455 | - 204 - No Content 456 | 457 | #### Response Body 458 | 459 | This request does not return a response body. 460 | 461 | --- 462 | 463 | ## Assign Connections to User Group 464 | 465 | Assign connections to an user group 466 | 467 | 468 | ### PATCH /api/session/data/{{data_source}}/userGroups/{{user_group}}/permissions 469 | 470 | #### Headers 471 | 472 | - Content-Type (string, required) - application/json 473 | 474 | #### Path Parameters 475 | 476 | - data_source (string, required) - Data source 477 | - user_group (string, required) - User group identifier 478 | 479 | #### Query Parameters 480 | 481 | - token (string, required) - Auth Token 482 | 483 | #### Request Body 484 | 485 | Body must be [json-patch](http://jsonpatch.com/) format. 486 | 487 | ```json 488 | [ 489 | { 490 | "op": "add", 491 | "path": "/connectionPermissions/{{connection}}", 492 | "value": "READ" 493 | } 494 | ] 495 | ``` 496 | 497 | ### Response 498 | 499 | #### Status Code 500 | 501 | - 204 - No Content 502 | 503 | #### Response Body 504 | 505 | This request does not return a response body. 506 | 507 | --- 508 | 509 | ## Revoke Connections from User Group 510 | 511 | Revoke connections from an user group. 512 | 513 | 514 | ### PATCH /api/session/data/{{data_source}}/userGroups/{{user_group}}/permissions 515 | 516 | #### Headers 517 | 518 | - Content-Type (string, required) - application/json 519 | 520 | #### Path Parameters 521 | 522 | - data_source (string, required) - Data source 523 | - user_group (string, required) - User group identifier 524 | 525 | #### Query Parameters 526 | 527 | - token (string, required) - Auth Token 528 | 529 | #### Request Body 530 | 531 | Body must be [json-patch](http://jsonpatch.com/) format. 532 | 533 | ```json 534 | [ 535 | { 536 | "op": "remove", 537 | "path": "/connectionPermissions/{{connection}}", 538 | "value": "READ" 539 | } 540 | ] 541 | ``` 542 | 543 | ### Response 544 | 545 | #### Status Code 546 | 547 | - 204 - No Content 548 | 549 | #### Response Body 550 | 551 | This request does not return a response body. 552 | 553 | --- 554 | 555 | ## Update User Group 556 | 557 | Updates user group. 558 | 559 | 560 | ### PUT /api/session/data/{{data_source}}/userGroups/{{user_group}} 561 | 562 | #### Headers 563 | 564 | - Content-Type (string, required) - application/json 565 | 566 | #### Path Parameters 567 | 568 | - data_source (string, required) - Data source 569 | - user_group (string, required) - User group identifier 570 | 571 | #### Query Parameters 572 | 573 | - token (string, required) - Auth Token 574 | 575 | #### Request Body 576 | 577 | **@TODO** 578 | 579 | ```json 580 | { 581 | "identifier": "test", 582 | "attributes": { 583 | "disabled": "" 584 | } 585 | } 586 | ``` 587 | 588 | ### Response 589 | 590 | #### Status Code 591 | 592 | - 204 - No Content 593 | 594 | #### Response Body 595 | 596 | This request does not return a response body. 597 | 598 | --- 599 | 600 | ## Create User Group 601 | 602 | Create a user group. 603 | 604 | 605 | ### POST /api/session/data/{{data_source}}/userGroups 606 | 607 | #### Headers 608 | 609 | - Content-Type (string, required) - application/json 610 | 611 | #### Path Parameters 612 | 613 | - data_source (string, required) - Data source 614 | 615 | #### Query Parameters 616 | 617 | - token (string, required) - Auth Token 618 | 619 | #### Request Body 620 | 621 | **@TODO** 622 | 623 | ```json 624 | { 625 | "identifier": "test", 626 | "attributes": { 627 | "disabled": "" 628 | } 629 | } 630 | ``` 631 | 632 | ### Response 633 | 634 | #### Status Code 635 | 636 | - 204 - No Content 637 | 638 | #### Response Body 639 | 640 | This request does not return a response body. 641 | 642 | --- 643 | 644 | ## Delete User Group 645 | 646 | Delete user group. 647 | 648 | 649 | ### DELETE /api/session/data/{{data_source}}/userGroups/{{user_group}} 650 | 651 | #### Headers 652 | 653 | None. 654 | 655 | #### Path Parameters 656 | 657 | - data_source (string, required) - Data source 658 | - user_group (string, required) - User group identifier 659 | 660 | #### Query Parameters 661 | 662 | - token (string, required) - Auth token 663 | 664 | #### Request Body 665 | 666 | None. 667 | 668 | ### Response 669 | 670 | #### Status Code 671 | 672 | - 204 - No Content 673 | 674 | #### Response Body 675 | 676 | This request does not return a response body. 677 | 678 | --- 679 | 680 | [Back to Top](#user-groups) 681 | -------------------------------------------------------------------------------- /docs/USERS.md: -------------------------------------------------------------------------------- 1 | 2 | # Users 3 | 4 | Manage users. 5 | 6 | 7 | # Table of Contents 8 | 9 | - [List Users](#list-users) 10 | - [Headers](#headers) 11 | - [Path Parameters](#path-parameters) 12 | - [Query Parameters](#query-parameters) 13 | - [Request Body](#request-body) 14 | - [Response](#response) 15 | - [Status Code](#status-code) 16 | - [Response Body](#response-body) 17 | - [Details of User](#details-of-user) 18 | - [Headers](#headers-1) 19 | - [Path Parameters](#path-parameters-1) 20 | - [Query Parameters](#query-parameters-1) 21 | - [Request Body](#request-body-1) 22 | - [Response](#response-1) 23 | - [Status Code](#status-code-1) 24 | - [Response Body](#response-body-1) 25 | - [Details of Self](#details-of-self) 26 | - [Headers](#headers-2) 27 | - [Path Parameters](#path-parameters-2) 28 | - [Query Parameters](#query-parameters-2) 29 | - [Request Body](#request-body-2) 30 | - [Response](#response-2) 31 | - [Status Code](#status-code-2) 32 | - [Response Body](#response-body-2) 33 | - [Details of User Permissions](#details-of-user-permissions) 34 | - [Headers](#headers-3) 35 | - [Path Parameters](#path-parameters-3) 36 | - [Query Parameters](#query-parameters-3) 37 | - [Request Body](#request-body-3) 38 | - [Response](#response-3) 39 | - [Status Code](#status-code-3) 40 | - [Response Body](#response-body-3) 41 | - [Details of User Effective Permissions](#details-of-user-effective-permissions) 42 | - [Headers](#headers-4) 43 | - [Path Parameters](#path-parameters-4) 44 | - [Query Parameters](#query-parameters-4) 45 | - [Request Body](#request-body-4) 46 | - [Response](#response-4) 47 | - [Status Code](#status-code-4) 48 | - [Response Body](#response-body-4) 49 | - [Details of User Groups](#details-of-user-groups) 50 | - [Headers](#headers-5) 51 | - [Path Parameters](#path-parameters-5) 52 | - [Query Parameters](#query-parameters-5) 53 | - [Request Body](#request-body-5) 54 | - [Response](#response-5) 55 | - [Status Code](#status-code-5) 56 | - [Response Body](#response-body-5) 57 | - [Details of User History](#details-of-user-history) 58 | - [Headers](#headers-6) 59 | - [Path Parameters](#path-parameters-6) 60 | - [Query Parameters](#query-parameters-6) 61 | - [Request Body](#request-body-6) 62 | - [Response](#response-6) 63 | - [Status Code](#status-code-6) 64 | - [Response Body](#response-body-6) 65 | - [Assign User to User Groups](#assign-user-to-user-groups) 66 | - [Headers](#headers-7) 67 | - [Path Parameters](#path-parameters-7) 68 | - [Query Parameters](#query-parameters-7) 69 | - [Request Body](#request-body-7) 70 | - [Response](#response-7) 71 | - [Status Code](#status-code-7) 72 | - [Response Body](#response-body-7) 73 | - [Revoke User from User Groups](#revoke-user-from-user-groups) 74 | - [Headers](#headers-8) 75 | - [Path Parameters](#path-parameters-8) 76 | - [Query Parameters](#query-parameters-8) 77 | - [Request Body](#request-body-8) 78 | - [Response](#response-8) 79 | - [Status Code](#status-code-8) 80 | - [Response Body](#response-body-8) 81 | - [Assign User to Connections](#assign-user-to-connections) 82 | - [Headers](#headers-9) 83 | - [Path Parameters](#path-parameters-9) 84 | - [Query Parameters](#query-parameters-9) 85 | - [Request Body](#request-body-9) 86 | - [Response](#response-9) 87 | - [Status Code](#status-code-9) 88 | - [Response Body](#response-body-9) 89 | - [Revoke User from Connections](#revoke-user-from-connections) 90 | - [Headers](#headers-10) 91 | - [Path Parameters](#path-parameters-10) 92 | - [Query Parameters](#query-parameters-10) 93 | - [Request Body](#request-body-10) 94 | - [Response](#response-10) 95 | - [Status Code](#status-code-10) 96 | - [Response Body](#response-body-10) 97 | - [Update User Password](#update-user-password) 98 | - [Headers](#headers-11) 99 | - [Path Parameters](#path-parameters-11) 100 | - [Query Parameters](#query-parameters-11) 101 | - [Request Body](#request-body-11) 102 | - [Response](#response-11) 103 | - [Status Code](#status-code-11) 104 | - [Response Body](#response-body-11) 105 | - [Update User](#update-user) 106 | - [Headers](#headers-12) 107 | - [Path Parameters](#path-parameters-12) 108 | - [Query Parameters](#query-parameters-12) 109 | - [Request Body](#request-body-12) 110 | - [Response](#response-12) 111 | - [Status Code](#status-code-12) 112 | - [Response Body](#response-body-12) 113 | - [Create User](#create-user) 114 | - [Headers](#headers-13) 115 | - [Path Parameters](#path-parameters-13) 116 | - [Query Parameters](#query-parameters-13) 117 | - [Request Body](#request-body-13) 118 | - [Response](#response-13) 119 | - [Status Code](#status-code-13) 120 | - [Response Body](#response-body-13) 121 | - [Delete User](#delete-user) 122 | - [Headers](#headers-14) 123 | - [Path Parameters](#path-parameters-14) 124 | - [Query Parameters](#query-parameters-14) 125 | - [Request Body](#request-body-14) 126 | - [Response](#response-14) 127 | - [Status Code](#status-code-14) 128 | - [Response Body](#response-body-14) 129 | 130 | ## List Users 131 | 132 | List users. 133 | 134 | 135 | ### GET /api/session/data/{{data_source}}/users 136 | 137 | #### Headers 138 | 139 | None. 140 | 141 | #### Path Parameters 142 | 143 | - data_source (string, required) - Data source 144 | 145 | #### Query Parameters 146 | 147 | - token (string, required) - Auth token 148 | 149 | #### Request Body 150 | 151 | None. 152 | 153 | ### Response 154 | 155 | #### Status Code 156 | 157 | - 200 - OK 158 | 159 | #### Response Body 160 | 161 | **@TODO** 162 | 163 | --- 164 | 165 | ## Details of User 166 | 167 | Details of user. 168 | 169 | 170 | ### GET /api/session/data/{{data_source}}/users/{{username}} 171 | 172 | #### Headers 173 | 174 | None. 175 | 176 | #### Path Parameters 177 | 178 | - data_source (string, required) - Data source 179 | - username (string, required) - Username 180 | 181 | #### Query Parameters 182 | 183 | - token (string, required) - Auth Token 184 | 185 | #### Request Body 186 | 187 | None. 188 | 189 | ### Response 190 | 191 | #### Status Code 192 | 193 | - 200 - OK 194 | 195 | #### Response Body 196 | 197 | **@TODO** 198 | 199 | --- 200 | 201 | ## Details of Self 202 | 203 | Details of token owner. 204 | 205 | 206 | ### GET /api/session/data/{{data_source}}/self 207 | 208 | #### Headers 209 | 210 | None. 211 | 212 | #### Path Parameters 213 | 214 | - data_source (string, required) - Data source 215 | 216 | #### Query Parameters 217 | 218 | - token (string, required) - Auth token 219 | 220 | #### Request Body 221 | 222 | None. 223 | 224 | ### Response 225 | 226 | #### Status Code 227 | 228 | - 200 - OK 229 | 230 | #### Response Body 231 | 232 | **@TODO** 233 | 234 | --- 235 | 236 | ## Details of User Permissions 237 | 238 | Details of user permissions. 239 | 240 | 241 | ### GET /api/session/data/{{data_source}}/users/{{username}}/permissions 242 | 243 | #### Headers 244 | 245 | None. 246 | 247 | #### Path Parameters 248 | 249 | - data_source (string, required) - Data source 250 | - username (string, required) - Username 251 | 252 | #### Query Parameters 253 | 254 | - token (string, required) - Auth Token 255 | 256 | #### Request Body 257 | 258 | None. 259 | 260 | ### Response 261 | 262 | #### Status Code 263 | 264 | - 200 - OK 265 | 266 | #### Response Body 267 | 268 | **@TODO** 269 | 270 | --- 271 | 272 | ## Details of User Effective Permissions 273 | 274 | Details of user effective permissions. 275 | 276 | 277 | ### GET /api/session/data/{{data_source}}/users/{{username}}/effectivePermissions 278 | 279 | #### Headers 280 | 281 | None. 282 | 283 | #### Path Parameters 284 | 285 | - data_source (string, required) - Data source 286 | - username (string, required) - Username 287 | 288 | #### Query Parameters 289 | 290 | - token (string, required) - Auth Token 291 | 292 | #### Request Body 293 | 294 | None. 295 | 296 | ### Response 297 | 298 | #### Status Code 299 | 300 | - 200 - OK 301 | 302 | #### Response Body 303 | 304 | **@TODO** 305 | 306 | --- 307 | 308 | ## Details of User Groups 309 | 310 | Details of user groups. 311 | 312 | 313 | ### GET /api/session/data/{{data_source}}/users/{{username}}/userGroups 314 | 315 | #### Headers 316 | 317 | None. 318 | 319 | #### Path Parameters 320 | 321 | - data_source (string, required) - Data source 322 | - username (string, required) - Username 323 | 324 | #### Query Parameters 325 | 326 | - token (string, required) - Auth Token 327 | 328 | #### Request Body 329 | 330 | None. 331 | 332 | ### Response 333 | 334 | #### Status Code 335 | 336 | - 200 - OK 337 | 338 | #### Response Body 339 | 340 | **@TODO** 341 | 342 | --- 343 | 344 | ## Details of User History 345 | 346 | Details of user history. 347 | 348 | 349 | ### GET /api/session/data/{{data_source}}/users/{{username}}/history 350 | 351 | #### Headers 352 | 353 | None. 354 | 355 | #### Path Parameters 356 | 357 | - data_source (string, required) - Data source 358 | - username (string, required) - Username 359 | 360 | #### Query Parameters 361 | 362 | - token (string, required) - Auth Token 363 | 364 | #### Request Body 365 | 366 | None. 367 | 368 | ### Response 369 | 370 | #### Status Code 371 | 372 | - 200 - OK 373 | 374 | #### Response Body 375 | 376 | **@TODO** 377 | 378 | --- 379 | 380 | ## Assign User to User Groups 381 | 382 | Assign user to user groups. 383 | 384 | 385 | ### PATCH /api/session/data/{{data_source}}/users/{{username}}/userGroups 386 | 387 | #### Headers 388 | 389 | - Content-Type (string, required) - application/json 390 | 391 | #### Path Parameters 392 | 393 | - data_source (string, required) - Data source 394 | - username (string, required) - Username 395 | 396 | #### Query Parameters 397 | 398 | - token (string, required) - Auth Token 399 | 400 | #### Request Body 401 | 402 | Body must be [json-patch](http://jsonpatch.com/) format. 403 | 404 | ```json 405 | [ 406 | { 407 | "op": "add", 408 | "path": "/", 409 | "value": "{{user_group}}" 410 | } 411 | ] 412 | ``` 413 | 414 | ### Response 415 | 416 | #### Status Code 417 | 418 | - 204 - No Content 419 | 420 | #### Response Body 421 | 422 | This request does not return a response body. 423 | 424 | --- 425 | 426 | ## Revoke User from User Groups 427 | 428 | Revoke user from user groups. 429 | 430 | 431 | ### PATCH /api/session/data/{{data_source}}/users/{{username}}/userGroups 432 | 433 | #### Headers 434 | 435 | - Content-Type (string, required) - application/json 436 | 437 | #### Path Parameters 438 | 439 | - data_source (string, required) - Data source 440 | - username (string, required) - Username 441 | 442 | #### Query Parameters 443 | 444 | - token (string, required) - Auth Token 445 | 446 | #### Request Body 447 | 448 | Body must be [json-patch](http://jsonpatch.com/) format. 449 | 450 | ```json 451 | [ 452 | { 453 | "op": "remove", 454 | "path": "/", 455 | "value": "{{user_group}}" 456 | } 457 | ] 458 | ``` 459 | 460 | ### Response 461 | 462 | #### Status Code 463 | 464 | - 204 - No Content 465 | 466 | #### Response Body 467 | 468 | This request does not return a response body. 469 | 470 | --- 471 | 472 | ## Assign User to Connections 473 | 474 | Assign user to connections. 475 | 476 | 477 | ### PATCH /api/session/data/{{data_source}}/users/{{username}}/permissions 478 | 479 | #### Headers 480 | 481 | - Content-Type (string, required) - application/json 482 | 483 | #### Path Parameters 484 | 485 | - data_source (string, required) - Data source 486 | - username (string, required) - Username 487 | 488 | #### Query Parameters 489 | 490 | - token (string, required) - Auth Token 491 | 492 | #### Request Body 493 | 494 | Body must be [json-patch](http://jsonpatch.com/) format. 495 | 496 | ```json 497 | [ 498 | { 499 | "op": "add", 500 | "path": "/connectionPermissions/{{connectionId}}", 501 | "value": "READ" 502 | } 503 | ] 504 | ``` 505 | 506 | You may also include connection groups (folders), and must if the connection that you wish to allow access to is within a connection group. 507 | 508 | ```json 509 | [ 510 | { 511 | "op": "add", 512 | "path": "/connectionGroupPermissions/{{connectionGroupId}}", 513 | "value": "READ" 514 | } 515 | ] 516 | ``` 517 | 518 | 519 | ### Response 520 | 521 | #### Status Code 522 | 523 | - 204 - No Content 524 | 525 | #### Response Body 526 | 527 | This request does not return a response body. 528 | 529 | --- 530 | 531 | ## Revoke User from Connections 532 | 533 | Revoke user from connections. 534 | 535 | 536 | ### PATCH /api/session/data/{{data_source}}/users/{{username}}/permissions 537 | 538 | #### Headers 539 | 540 | - Content-Type (string, required) - application/json 541 | 542 | #### Path Parameters 543 | 544 | - data_source (string, required) - Data source 545 | - username (string, required) - Username 546 | 547 | #### Query Parameters 548 | 549 | - token (string, required) - Auth Token 550 | 551 | #### Request Body 552 | 553 | Body must be [json-patch](http://jsonpatch.com/) format. 554 | 555 | ```json 556 | [ 557 | { 558 | "op": "remove", 559 | "path": "/connectionPermissions/{{connectionId}}", 560 | "value": "READ" 561 | } 562 | ] 563 | ``` 564 | 565 | You may also include connection groups (folders) 566 | 567 | ```json 568 | [ 569 | { 570 | "op": "remove", 571 | "path": "/connectionGroupPermissions/{{connectionGroupId}}", 572 | "value": "READ" 573 | } 574 | ] 575 | ``` 576 | 577 | ### Response 578 | 579 | #### Status Code 580 | 581 | - 204 - No Content 582 | 583 | #### Response Body 584 | 585 | This request does not return a response body. 586 | 587 | --- 588 | 589 | ## Update User Password 590 | 591 | Updates user password. 592 | 593 | 594 | ### PUT /api/session/data/{{data_source}}/users/{{username}}/password 595 | 596 | #### Headers 597 | 598 | - Content-Type (string, required) - application/json 599 | 600 | #### Path Parameters 601 | 602 | - data_source (string, required) - Data source 603 | - username (string, required) - Username 604 | 605 | #### Query Parameters 606 | 607 | - token (string, required) - Auth Token 608 | 609 | #### Request Body 610 | 611 | - oldPassword (string, required) - Old password 612 | - newPassword (string, required) - New password 613 | 614 | ```json 615 | { 616 | "oldPassword": "{{oldPassword}}", 617 | "newPassword": "{{newPassword}}" 618 | } 619 | ``` 620 | 621 | ### Response 622 | 623 | #### Status Code 624 | 625 | - 204 - No Content 626 | 627 | #### Response Body 628 | 629 | This request does not return a response body. 630 | 631 | --- 632 | 633 | ## Update User 634 | 635 | Updates user. 636 | 637 | 638 | ### PUT /api/session/data/{{data_source}}/users/{{username}} 639 | 640 | #### Headers 641 | 642 | - Content-Type (string, required) - application/json 643 | 644 | #### Path Parameters 645 | 646 | - data_source (string, required) - Data source 647 | - username (string, required) - Username 648 | 649 | #### Query Parameters 650 | 651 | - token (string, required) - Auth Token 652 | 653 | #### Request Body 654 | 655 | **@TODO** 656 | 657 | ```json 658 | { 659 | "username": "{{username}}", 660 | "attributes": { 661 | "guac-email-address": null, 662 | "guac-organizational-role": null, 663 | "guac-full-name": null, 664 | "expired": "", 665 | "timezone": null, 666 | "access-window-start": "", 667 | "guac-organization": null, 668 | "access-window-end": "", 669 | "disabled": "", 670 | "valid-until": "", 671 | "valid-from": "" 672 | } 673 | } 674 | ``` 675 | 676 | ### Response 677 | 678 | #### Status Code 679 | 680 | - 204 - No Content 681 | 682 | #### Response Body 683 | 684 | This request does not return a response body. 685 | 686 | --- 687 | 688 | ## Create User 689 | 690 | Creates a user. 691 | 692 | 693 | ### POST /api/session/data/{{data_source}}/users 694 | 695 | #### Headers 696 | 697 | - Content-Type (string, required) - application/json 698 | 699 | #### Path Parameters 700 | 701 | - data_source (string, required) - Data source 702 | 703 | #### Query Parameters 704 | 705 | - token (string, required) - Auth Token 706 | 707 | #### Request Body 708 | 709 | **@TODO** 710 | 711 | ```json 712 | { 713 | "username": "test", 714 | "password": "pass", 715 | "attributes": { 716 | "disabled": "", 717 | "expired": "", 718 | "access-window-start": "", 719 | "access-window-end": "", 720 | "valid-from": "", 721 | "valid-until": "", 722 | "timezone": null, 723 | "guac-full-name": "", 724 | "guac-organization": "", 725 | "guac-organizational-role": "" 726 | } 727 | } 728 | ``` 729 | 730 | ### Response 731 | 732 | #### Status Code 733 | 734 | - 200 - OK 735 | 736 | #### Response Body 737 | 738 | **@TODO** 739 | 740 | ## Delete User 741 | 742 | Delete user. 743 | 744 | 745 | ### DELETE /api/session/data/{{data_source}}/users/{{username}} 746 | 747 | #### Headers 748 | 749 | None. 750 | 751 | #### Path Parameters 752 | 753 | - data_source (string, required) - Data source 754 | - username (integer, required) - Username 755 | 756 | #### Query Parameters 757 | 758 | - token (string, required) - Auth token 759 | 760 | #### Request Body 761 | 762 | None. 763 | 764 | ### Response 765 | 766 | #### Status Code 767 | 768 | - 204 - No Content 769 | 770 | #### Response Body 771 | 772 | This request does not return a response body. 773 | 774 | --- 775 | 776 | [Back to Top](#users) 777 | -------------------------------------------------------------------------------- /docs/CONNECTIONS.md: -------------------------------------------------------------------------------- 1 | 2 | # Connections 3 | 4 | Manage connections. 5 | 6 | 7 | # Table of Contents 8 | 9 | - [List Connections](#list-connections) 10 | - [Headers](#headers) 11 | - [Path Parameters](#path-parameters) 12 | - [Details of Connection](#details-of-connection) 13 | - [Headers](#headers-1) 14 | - [Path Parameters](#path-parameters-1) 15 | - [Query Parameters](#query-parameters) 16 | - [Request Body](#request-body) 17 | - [Response](#response) 18 | - [Status Code](#status-code) 19 | - [Response Body](#response-body) 20 | - [Details of Connection Parameters](#details-of-connection-parameters) 21 | - [Headers](#headers-2) 22 | - [Path Parameters](#path-parameters-2) 23 | - [Query Parameters](#query-parameters-1) 24 | - [Request Body](#request-body-1) 25 | - [Response](#response-1) 26 | - [Status Code](#status-code-1) 27 | - [Response Body](#response-body-1) 28 | - [Details of Connection History](#details-of-connection-history) 29 | - [Headers](#headers-3) 30 | - [Path Parameters](#path-parameters-3) 31 | - [Query Parameters](#query-parameters-2) 32 | - [Request Body](#request-body-2) 33 | - [Response](#response-2) 34 | - [Status Code](#status-code-2) 35 | - [Response Body](#response-body-2) 36 | - [Details of Connection Sharing Profiles](#details-of-connection-sharing-profiles) 37 | - [Headers](#headers-4) 38 | - [Path Parameters](#path-parameters-4) 39 | - [Query Parameters](#query-parameters-3) 40 | - [List Sharing Profiles](#list-sharing-profiles) 41 | - [Headers](#headers-5) 42 | - [Path Parameters](#path-parameters-5) 43 | - [Query Parameters](#query-parameters-4) 44 | - [Request Body](#request-body-3) 45 | - [Response](#response-3) 46 | - [Status Code](#status-code-3) 47 | - [Response Body](#response-body-3) 48 | - [List Active Connections](#list-active-connections) 49 | - [Headers](#headers-6) 50 | - [Path Parameters](#path-parameters-6) 51 | - [Query Parameters](#query-parameters-5) 52 | - [Request Body](#request-body-4) 53 | - [Response](#response-4) 54 | - [Status Code](#status-code-4) 55 | - [Response Body](#response-body-4) 56 | - [Kill Connections](#kill-connections) 57 | - [Headers](#headers-7) 58 | - [Path Parameters](#path-parameters-7) 59 | - [Query Parameters](#query-parameters-6) 60 | - [Request Body](#request-body-5) 61 | - [Response](#response-5) 62 | - [Status Code](#status-code-5) 63 | - [Response Body](#response-body-5) 64 | - [Create VNC Connection](#create-vnc-connection) 65 | - [Headers](#headers-8) 66 | - [Path Parameters](#path-parameters-8) 67 | - [Query Parameters](#query-parameters-7) 68 | - [Request Body](#request-body-6) 69 | - [Response](#response-6) 70 | - [Status Code](#status-code-6) 71 | - [Response Body](#response-body-6) 72 | - [Create SSH Connection](#create-ssh-connection) 73 | - [Headers](#headers-9) 74 | - [Path Parameters](#path-parameters-9) 75 | - [Query Parameters](#query-parameters-8) 76 | - [Request Body](#request-body-7) 77 | - [Response](#response-7) 78 | - [Status Code](#status-code-7) 79 | - [Response Body](#response-body-7) 80 | - [Create RDP Connection](#create-rdp-connection) 81 | - [Headers](#headers-10) 82 | - [Path Parameters](#path-parameters-10) 83 | - [Query Parameters](#query-parameters-9) 84 | - [Request Body](#request-body-8) 85 | - [Response](#response-8) 86 | - [Status Code](#status-code-8) 87 | - [Response Body](#response-body-8) 88 | - [Create Telnet Connection](#create-telnet-connection) 89 | - [Headers](#headers-11) 90 | - [Path Parameters](#path-parameters-11) 91 | - [Query Parameters](#query-parameters-10) 92 | - [Request Body](#request-body-9) 93 | - [Response](#response-9) 94 | - [Status Code](#status-code-9) 95 | - [Response Body](#response-body-9) 96 | - [Create Kubernetes Connection](#create-kubernetes-connection) 97 | - [Headers](#headers-12) 98 | - [Path Parameters](#path-parameters-12) 99 | - [Query Parameters](#query-parameters-11) 100 | - [Request Body](#request-body-10) 101 | - [Response](#response-10) 102 | - [Status Code](#status-code-10) 103 | - [Response Body](#response-body-10) 104 | - [Update VNC Connection](#update-vnc-connection) 105 | - [Headers](#headers-13) 106 | - [Path Parameters](#path-parameters-13) 107 | - [Query Parameters](#query-parameters-12) 108 | - [Request Body](#request-body-11) 109 | - [Response](#response-11) 110 | - [Status Code](#status-code-11) 111 | - [Response Body](#response-body-11) 112 | - [Update SSH Connection](#update-ssh-connection) 113 | - [Headers](#headers-14) 114 | - [Path Parameters](#path-parameters-14) 115 | - [Query Parameters](#query-parameters-13) 116 | - [Request Body](#request-body-12) 117 | - [Response](#response-12) 118 | - [Status Code](#status-code-12) 119 | - [Response Body](#response-body-12) 120 | - [Update RDP Connection](#update-rdp-connection) 121 | - [Headers](#headers-15) 122 | - [Path Parameters](#path-parameters-15) 123 | - [Query Parameters](#query-parameters-14) 124 | - [Request Body](#request-body-13) 125 | - [Response](#response-13) 126 | - [Status Code](#status-code-13) 127 | - [Response Body](#response-body-13) 128 | - [Update Telnet Connection](#update-telnet-connection) 129 | - [Headers](#headers-16) 130 | - [Path Parameters](#path-parameters-16) 131 | - [Query Parameters](#query-parameters-15) 132 | - [Request Body](#request-body-14) 133 | - [Response](#response-14) 134 | - [Status Code](#status-code-14) 135 | - [Response Body](#response-body-14) 136 | - [Update Kubernetes Connection](#update-kubernetes-connection) 137 | - [Headers](#headers-17) 138 | - [Path Parameters](#path-parameters-17) 139 | - [Query Parameters](#query-parameters-16) 140 | - [Request Body](#request-body-15) 141 | - [Response](#response-15) 142 | - [Status Code](#status-code-15) 143 | - [Response Body](#response-body-15) 144 | - [Delete Connection](#delete-connection) 145 | - [Headers](#headers-18) 146 | - [Path Parameters](#path-parameters-18) 147 | - [Query Parameters](#query-parameters-17) 148 | - [Request Body](#request-body-16) 149 | - [Response](#response-16) 150 | - [Status Code](#status-code-16) 151 | - [Response Body](#response-body-16) 152 | 153 | ## List Connections 154 | 155 | List connections. 156 | 157 | 158 | ### GET /api/session/data/{{data_source}}/connections 159 | 160 | #### Headers 161 | 162 | None. 163 | 164 | #### Path Parameters 165 | 166 | - data_source (string, required) - Data source 167 | 168 | --- 169 | 170 | ## Details of Connection 171 | 172 | Details of connection. 173 | 174 | 175 | ### GET /api/session/data/{{data_source}}/connections/{{connection}} 176 | 177 | #### Headers 178 | 179 | None. 180 | 181 | #### Path Parameters 182 | 183 | - data_source (string, required) - Data source 184 | - connection (integer, required) - Connection identifier 185 | 186 | #### Query Parameters 187 | 188 | - token (string, required) - Auth Token 189 | 190 | #### Request Body 191 | 192 | None. 193 | 194 | ### Response 195 | 196 | #### Status Code 197 | 198 | - 200 - OK 199 | 200 | #### Response Body 201 | 202 | **@TODO** 203 | 204 | --- 205 | 206 | ## Details of Connection Parameters 207 | 208 | Details of connection parameters. 209 | 210 | 211 | ### GET /api/session/data/{{data_source}}/connections/{{connection}}/parameters 212 | 213 | #### Headers 214 | 215 | None. 216 | 217 | #### Path Parameters 218 | 219 | - data_source (string, required) - Data source 220 | - connection (integer, required) - Connection identifier 221 | 222 | #### Query Parameters 223 | 224 | - token (string, required) - Auth Token 225 | 226 | #### Request Body 227 | 228 | None. 229 | 230 | ### Response 231 | 232 | #### Status Code 233 | 234 | - 200 - OK 235 | 236 | #### Response Body 237 | 238 | **@TODO** 239 | 240 | --- 241 | 242 | ## Details of Connection History 243 | 244 | Details of connection history. 245 | 246 | 247 | ### GET /api/session/data/{{data_source}}/connections/{{connection}}/history 248 | 249 | #### Headers 250 | 251 | None. 252 | 253 | #### Path Parameters 254 | 255 | - data_source (string, required) - Data source 256 | - connection (integer, required) - Connection identifier 257 | 258 | #### Query Parameters 259 | 260 | - token (string, required) - Auth Token 261 | 262 | #### Request Body 263 | 264 | None. 265 | 266 | ### Response 267 | 268 | #### Status Code 269 | 270 | - 200 - OK 271 | 272 | #### Response Body 273 | 274 | **@TODO** 275 | 276 | --- 277 | 278 | ## Details of Connection Sharing Profiles 279 | 280 | Details of connection sharing profiles. 281 | 282 | 283 | ### GET /api/session/data/{{data_source}}/connections/{{connection}}/sharingProfiles 284 | 285 | #### Headers 286 | 287 | None. 288 | 289 | #### Path Parameters 290 | 291 | - data_source (string, required) - Data source 292 | - connection (integer, required) - Connection identifier 293 | 294 | #### Query Parameters 295 | 296 | - token (string, required) - Auth Token 297 | 298 | --- 299 | 300 | ## List Sharing Profiles 301 | 302 | List sharing profiles. 303 | 304 | 305 | ### GET /api/session/data/{{data_source}}/sharingProfiles 306 | 307 | #### Headers 308 | 309 | None. 310 | 311 | #### Path Parameters 312 | 313 | - data_source (string, required) - Data source 314 | 315 | #### Query Parameters 316 | 317 | - token (string, required) - Auth Token 318 | 319 | #### Request Body 320 | 321 | None. 322 | 323 | ### Response 324 | 325 | #### Status Code 326 | 327 | - 200 - OK 328 | 329 | #### Response Body 330 | 331 | **@TODO** 332 | 333 | --- 334 | 335 | ## List Active Connections 336 | 337 | List active connections. 338 | 339 | 340 | ### GET /api/session/data/{{data_source}}/activeConnections 341 | 342 | #### Headers 343 | 344 | None. 345 | 346 | #### Path Parameters 347 | 348 | - data_source (string, required) - Data source 349 | 350 | #### Query Parameters 351 | 352 | - token (string, required) - Auth Token 353 | 354 | #### Request Body 355 | 356 | None. 357 | 358 | ### Response 359 | 360 | #### Status Code 361 | 362 | - 200 - OK 363 | 364 | #### Response Body 365 | 366 | **@TODO** 367 | 368 | --- 369 | 370 | ## Kill Connections 371 | 372 | Kill connections. 373 | 374 | 375 | ### PATCH /api/session/data/{{data_source}}/activeConnections 376 | 377 | #### Headers 378 | 379 | - Content-Type (string, required) - application/json 380 | 381 | #### Path Parameters 382 | 383 | - data_source (string, required) - Data source 384 | 385 | #### Query Parameters 386 | 387 | - token (string, required) - Auth Token 388 | 389 | #### Request Body 390 | 391 | Body must be [json-patch](http://jsonpatch.com/) format. 392 | 393 | ```json 394 | [ 395 | { 396 | "op": "remove", 397 | "path": "/{{activeConnectionIdentifier}}" 398 | } 399 | ] 400 | ``` 401 | 402 | ### Response 403 | 404 | #### Status Code 405 | 406 | - 200 - OK 407 | 408 | #### Response Body 409 | 410 | **@TODO** 411 | 412 | --- 413 | 414 | ## Create VNC Connection 415 | 416 | Creates a VNC connection. 417 | 418 | 419 | ### POST /api/session/data/{{data_source}}/connections 420 | 421 | #### Headers 422 | 423 | - Content-Type (string, required) - application/json 424 | 425 | #### Path Parameters 426 | 427 | - data_source (string, required) - Data source 428 | 429 | #### Query Parameters 430 | 431 | - token (string, required) - Auth Token 432 | 433 | #### Request Body 434 | 435 | **@TODO** 436 | 437 | ```json 438 | { 439 | "parentIdentifier": "ROOT", 440 | "name": "test", 441 | "protocol": "vnc", 442 | "parameters": { 443 | "port": "", 444 | "read-only": "", 445 | "swap-red-blue": "", 446 | "cursor": "", 447 | "color-depth": "", 448 | "clipboard-encoding": "", 449 | "disable-copy": "", 450 | "disable-paste": "", 451 | "dest-port": "", 452 | "recording-exclude-output": "", 453 | "recording-exclude-mouse": "", 454 | "recording-include-keys": "", 455 | "create-recording-path": "", 456 | "enable-sftp": "true", 457 | "sftp-port": "", 458 | "sftp-server-alive-interval": "", 459 | "enable-audio": "", 460 | "audio-servername": "", 461 | "sftp-directory": "", 462 | "sftp-root-directory": "", 463 | "sftp-passphrase": "", 464 | "sftp-private-key": "", 465 | "sftp-username": "", 466 | "sftp-password": "", 467 | "sftp-host-key": "", 468 | "sftp-hostname": "", 469 | "recording-name": "", 470 | "recording-path": "", 471 | "dest-host": "", 472 | "password": "", 473 | "username": "", 474 | "hostname": "" 475 | }, 476 | "attributes": { 477 | "max-connections": "", 478 | "max-connections-per-user": "", 479 | "weight": "", 480 | "failover-only": "", 481 | "guacd-port": "", 482 | "guacd-encryption": "", 483 | "guacd-hostname": "" 484 | } 485 | } 486 | ``` 487 | 488 | ### Response 489 | 490 | #### Status Code 491 | 492 | - 200 - OK 493 | 494 | #### Response Body 495 | 496 | **@TODO** 497 | 498 | --- 499 | 500 | ## Create SSH Connection 501 | 502 | Creates a SSH connection. 503 | 504 | 505 | ### POST /api/session/data/{{data_source}}/connections 506 | 507 | #### Headers 508 | 509 | - Content-Type (string, required) - application/json 510 | 511 | #### Path Parameters 512 | 513 | - data_source (string, required) - Data source 514 | 515 | #### Query Parameters 516 | 517 | - token (string, required) - Auth Token 518 | 519 | #### Request Body 520 | 521 | **@TODO** 522 | 523 | ```json 524 | { 525 | "parentIdentifier": "ROOT", 526 | "name": "test", 527 | "protocol": "ssh", 528 | "parameters": { 529 | "port": "", 530 | "read-only": "", 531 | "swap-red-blue": "", 532 | "cursor": "", 533 | "color-depth": "", 534 | "clipboard-encoding": "", 535 | "disable-copy": "", 536 | "disable-paste": "", 537 | "dest-port": "", 538 | "recording-exclude-output": "", 539 | "recording-exclude-mouse": "", 540 | "recording-include-keys": "", 541 | "create-recording-path": "", 542 | "enable-sftp": "", 543 | "sftp-port": "", 544 | "sftp-server-alive-interval": "", 545 | "enable-audio": "", 546 | "color-scheme": "", 547 | "font-size": "", 548 | "scrollback": "", 549 | "timezone": null, 550 | "server-alive-interval": "", 551 | "backspace": "", 552 | "terminal-type": "", 553 | "create-typescript-path": "", 554 | "hostname": "", 555 | "host-key": "", 556 | "private-key": "", 557 | "username": "", 558 | "password": "", 559 | "passphrase": "", 560 | "font-name": "", 561 | "command": "", 562 | "locale": "", 563 | "typescript-path": "", 564 | "typescript-name": "", 565 | "recording-path": "", 566 | "recording-name": "", 567 | "sftp-root-directory": "" 568 | }, 569 | "attributes": { 570 | "max-connections": "", 571 | "max-connections-per-user": "", 572 | "weight": "", 573 | "failover-only": "", 574 | "guacd-port": "", 575 | "guacd-encryption": "", 576 | "guacd-hostname": "" 577 | } 578 | } 579 | ``` 580 | 581 | ### Response 582 | 583 | #### Status Code 584 | 585 | - 200 - OK 586 | 587 | #### Response Body 588 | 589 | **@TODO** 590 | 591 | --- 592 | 593 | ## Create RDP Connection 594 | 595 | Creates a RDP connection. 596 | 597 | 598 | ### POST /api/session/data/{{data_source}}/connections 599 | 600 | #### Headers 601 | 602 | - Content-Type (string, required) - application/json 603 | 604 | #### Path Parameters 605 | 606 | - data_source (string, required) - Data source 607 | 608 | #### Query Parameters 609 | 610 | - token (string, required) - Auth Token 611 | 612 | #### Request Body 613 | 614 | **@TODO** 615 | 616 | ```json 617 | { 618 | "parentIdentifier": "ROOT", 619 | "name": "test", 620 | "protocol": "rdp", 621 | "parameters": { 622 | "port": "", 623 | "read-only": "", 624 | "swap-red-blue": "", 625 | "cursor": "", 626 | "color-depth": "", 627 | "clipboard-encoding": "", 628 | "disable-copy": "", 629 | "disable-paste": "", 630 | "dest-port": "", 631 | "recording-exclude-output": "", 632 | "recording-exclude-mouse": "", 633 | "recording-include-keys": "", 634 | "create-recording-path": "", 635 | "enable-sftp": "", 636 | "sftp-port": "", 637 | "sftp-server-alive-interval": "", 638 | "enable-audio": "", 639 | "security": "", 640 | "disable-auth": "", 641 | "ignore-cert": "", 642 | "gateway-port": "", 643 | "server-layout": "", 644 | "timezone": "", 645 | "console": "", 646 | "width": "", 647 | "height": "", 648 | "dpi": "", 649 | "resize-method": "", 650 | "console-audio": "", 651 | "disable-audio": "", 652 | "enable-audio-input": "", 653 | "enable-printing": "", 654 | "enable-drive": "", 655 | "create-drive-path": "", 656 | "enable-wallpaper": "", 657 | "enable-theming": "", 658 | "enable-font-smoothing": "", 659 | "enable-full-window-drag": "", 660 | "enable-desktop-composition": "", 661 | "enable-menu-animations": "", 662 | "disable-bitmap-caching": "", 663 | "disable-offscreen-caching": "", 664 | "disable-glyph-caching": "", 665 | "preconnection-id": "", 666 | "hostname": "", 667 | "username": "", 668 | "password": "", 669 | "domain": "", 670 | "gateway-hostname": "", 671 | "gateway-username": "", 672 | "gateway-password": "", 673 | "gateway-domain": "", 674 | "initial-program": "", 675 | "client-name": "", 676 | "printer-name": "", 677 | "drive-name": "", 678 | "drive-path": "", 679 | "static-channels": "", 680 | "remote-app": "", 681 | "remote-app-dir": "", 682 | "remote-app-args": "", 683 | "preconnection-blob": "", 684 | "load-balance-info": "", 685 | "recording-path": "", 686 | "recording-name": "", 687 | "sftp-hostname": "", 688 | "sftp-host-key": "", 689 | "sftp-username": "", 690 | "sftp-password": "", 691 | "sftp-private-key": "", 692 | "sftp-passphrase": "", 693 | "sftp-root-directory": "", 694 | "sftp-directory": "" 695 | }, 696 | "attributes": { 697 | "max-connections": "", 698 | "max-connections-per-user": "", 699 | "weight": "", 700 | "failover-only": "", 701 | "guacd-port": "", 702 | "guacd-encryption": "", 703 | "guacd-hostname": "" 704 | } 705 | } 706 | ``` 707 | 708 | ### Response 709 | 710 | #### Status Code 711 | 712 | - 200 - OK 713 | 714 | #### Response Body 715 | 716 | **@TODO** 717 | 718 | --- 719 | 720 | ## Create Telnet Connection 721 | 722 | Creates a Telnet connection. 723 | 724 | 725 | ### POST /api/session/data/{{data_source}}/connections 726 | 727 | #### Headers 728 | 729 | - Content-Type (string, required) - application/json 730 | 731 | #### Path Parameters 732 | 733 | - data_source (string, required) - Data source 734 | 735 | #### Query Parameters 736 | 737 | - token (string, required) - Auth Token 738 | 739 | #### Request Body 740 | 741 | **@TODO** 742 | 743 | ```json 744 | { 745 | "parentIdentifier": "ROOT", 746 | "name": "test", 747 | "protocol": "telnet", 748 | "parameters": { 749 | "port": "", 750 | "read-only": "", 751 | "swap-red-blue": "", 752 | "cursor": "", 753 | "color-depth": "", 754 | "clipboard-encoding": "", 755 | "disable-copy": "", 756 | "disable-paste": "", 757 | "dest-port": "", 758 | "recording-exclude-output": "", 759 | "recording-exclude-mouse": "", 760 | "recording-include-keys": "", 761 | "create-recording-path": "", 762 | "enable-sftp": "", 763 | "sftp-port": "", 764 | "sftp-server-alive-interval": "", 765 | "enable-audio": "", 766 | "color-scheme": "", 767 | "font-size": "", 768 | "scrollback": "", 769 | "backspace": "", 770 | "terminal-type": "", 771 | "create-typescript-path": "", 772 | "hostname": "", 773 | "username": "", 774 | "password": "", 775 | "username-regex": "", 776 | "password-regex": "", 777 | "login-success-regex": "", 778 | "login-failure-regex": "", 779 | "font-name": "", 780 | "typescript-path": "", 781 | "typescript-name": "", 782 | "recording-path": "", 783 | "recording-name": "" 784 | }, 785 | "attributes": { 786 | "max-connections": "", 787 | "max-connections-per-user": "", 788 | "weight": "", 789 | "failover-only": "", 790 | "guacd-port": "", 791 | "guacd-encryption": "", 792 | "guacd-hostname": "" 793 | } 794 | } 795 | ``` 796 | 797 | ### Response 798 | 799 | #### Status Code 800 | 801 | - 200 - OK 802 | 803 | #### Response Body 804 | 805 | **@TODO** 806 | 807 | --- 808 | 809 | ## Create Kubernetes Connection 810 | 811 | Creates a Kubernetes connection. 812 | 813 | 814 | ### POST /api/session/data/{{data_source}}/connections 815 | 816 | #### Headers 817 | 818 | - Content-Type (string, required) - application/json 819 | 820 | #### Path Parameters 821 | 822 | - data_source (string, required) - Data source 823 | 824 | #### Query Parameters 825 | 826 | - token (string, required) - Auth Token 827 | 828 | #### Request Body 829 | 830 | **@TODO** 831 | 832 | ```json 833 | { 834 | "parentIdentifier": "ROOT", 835 | "name": "test", 836 | "protocol": "kubernetes", 837 | "parameters": { 838 | "port": "", 839 | "read-only": "", 840 | "swap-red-blue": "", 841 | "cursor": "", 842 | "color-depth": "", 843 | "clipboard-encoding": "", 844 | "disable-copy": "", 845 | "disable-paste": "", 846 | "dest-port": "", 847 | "recording-exclude-output": "", 848 | "recording-exclude-mouse": "", 849 | "recording-include-keys": "", 850 | "create-recording-path": "", 851 | "enable-sftp": "", 852 | "sftp-port": "", 853 | "sftp-server-alive-interval": "", 854 | "enable-audio": "", 855 | "use-ssl": "", 856 | "ignore-cert": "", 857 | "color-scheme": "", 858 | "font-size": "", 859 | "scrollback": "", 860 | "backspace": "", 861 | "create-typescript-path": "", 862 | "hostname": "", 863 | "ca-cert": "", 864 | "namespace": "", 865 | "pod": "", 866 | "container": "", 867 | "client-cert": "", 868 | "client-key": "", 869 | "font-name": "", 870 | "typescript-path": "", 871 | "typescript-name": "", 872 | "recording-path": "", 873 | "recording-name": "" 874 | }, 875 | "attributes": { 876 | "max-connections": "", 877 | "max-connections-per-user": "", 878 | "weight": "", 879 | "failover-only": "", 880 | "guacd-port": "", 881 | "guacd-encryption": "", 882 | "guacd-hostname": "" 883 | } 884 | } 885 | ``` 886 | 887 | ### Response 888 | 889 | #### Status Code 890 | 891 | - 200 - OK 892 | 893 | #### Response Body 894 | 895 | **@TODO** 896 | 897 | --- 898 | 899 | ## Update VNC Connection 900 | 901 | Updates VNC connection. 902 | 903 | 904 | ### PUT /api/session/data/{{data_source}}/connections/{{connection}} 905 | 906 | #### Headers 907 | 908 | - Content-Type (string, required) - application/json 909 | 910 | #### Path Parameters 911 | 912 | - data_source (string, required) - Data source 913 | - connection (integer, required) - Connection identifier 914 | 915 | #### Query Parameters 916 | 917 | - token (string, required) - Auth Token 918 | 919 | #### Request Body 920 | 921 | **@TODO** 922 | 923 | ```json 924 | { 925 | "parentIdentifier": "ROOT", 926 | "name": "test", 927 | "identifier": "1", 928 | "activeConnections": 0, 929 | "protocol": "vnc", 930 | "parameters": { 931 | "port": "", 932 | "read-only": "", 933 | "swap-red-blue": "", 934 | "cursor": "", 935 | "color-depth": "", 936 | "clipboard-encoding": "", 937 | "disable-copy": "", 938 | "disable-paste": "", 939 | "dest-port": "", 940 | "recording-exclude-output": "", 941 | "recording-exclude-mouse": "", 942 | "recording-include-keys": "", 943 | "create-recording-path": "", 944 | "enable-sftp": "true", 945 | "sftp-port": "", 946 | "sftp-server-alive-interval": "", 947 | "enable-audio": "", 948 | "audio-servername": "", 949 | "sftp-directory": "", 950 | "sftp-root-directory": "", 951 | "sftp-passphrase": "", 952 | "sftp-private-key": "", 953 | "sftp-username": "", 954 | "sftp-password": "", 955 | "sftp-host-key": "", 956 | "sftp-hostname": "", 957 | "recording-name": "", 958 | "recording-path": "", 959 | "dest-host": "", 960 | "password": "", 961 | "username": "", 962 | "hostname": "" 963 | }, 964 | "attributes": { 965 | "max-connections": "", 966 | "max-connections-per-user": "", 967 | "weight": "", 968 | "failover-only": "", 969 | "guacd-port": "", 970 | "guacd-encryption": "", 971 | "guacd-hostname": "" 972 | } 973 | } 974 | ``` 975 | 976 | ### Response 977 | 978 | #### Status Code 979 | 980 | - 204 - No Content 981 | 982 | #### Response Body 983 | 984 | This request does not return a response body. 985 | 986 | --- 987 | 988 | ## Update SSH Connection 989 | 990 | Updates SSH connection. 991 | 992 | 993 | ### PUT /api/session/data/{{data_source}}/connections/{{connection}} 994 | 995 | #### Headers 996 | 997 | - Content-Type (string, required) - application/json 998 | 999 | #### Path Parameters 1000 | 1001 | - data_source (string, required) - Data source 1002 | - connection (integer, required) - Connection identifier 1003 | 1004 | #### Query Parameters 1005 | 1006 | - token (string, required) - Auth Token 1007 | 1008 | #### Request Body 1009 | 1010 | **@TODO** 1011 | 1012 | ```json 1013 | { 1014 | "parentIdentifier": "ROOT", 1015 | "name": "test", 1016 | "identifier": "1", 1017 | "activeConnections": 0, 1018 | "protocol": "ssh", 1019 | "parameters": { 1020 | "port": "", 1021 | "read-only": "", 1022 | "swap-red-blue": "", 1023 | "cursor": "", 1024 | "color-depth": "", 1025 | "clipboard-encoding": "", 1026 | "disable-copy": "", 1027 | "disable-paste": "", 1028 | "dest-port": "", 1029 | "recording-exclude-output": "", 1030 | "recording-exclude-mouse": "", 1031 | "recording-include-keys": "", 1032 | "create-recording-path": "", 1033 | "enable-sftp": "", 1034 | "sftp-port": "", 1035 | "sftp-server-alive-interval": "", 1036 | "enable-audio": "", 1037 | "color-scheme": "", 1038 | "font-size": "", 1039 | "scrollback": "", 1040 | "timezone": null, 1041 | "server-alive-interval": "", 1042 | "backspace": "", 1043 | "terminal-type": "", 1044 | "create-typescript-path": "", 1045 | "hostname": "", 1046 | "host-key": "", 1047 | "private-key": "", 1048 | "username": "", 1049 | "password": "", 1050 | "passphrase": "", 1051 | "font-name": "", 1052 | "command": "", 1053 | "locale": "", 1054 | "typescript-path": "", 1055 | "typescript-name": "", 1056 | "recording-path": "", 1057 | "recording-name": "", 1058 | "sftp-root-directory": "" 1059 | }, 1060 | "attributes": { 1061 | "max-connections": "", 1062 | "max-connections-per-user": "", 1063 | "weight": "", 1064 | "failover-only": "", 1065 | "guacd-port": "", 1066 | "guacd-encryption": "", 1067 | "guacd-hostname": "" 1068 | } 1069 | } 1070 | ``` 1071 | 1072 | ### Response 1073 | 1074 | #### Status Code 1075 | 1076 | - 204 - No Content 1077 | 1078 | #### Response Body 1079 | 1080 | This request does not return a response body. 1081 | 1082 | --- 1083 | 1084 | ## Update RDP Connection 1085 | 1086 | Updates RDP connection. 1087 | 1088 | 1089 | ### PUT /api/session/data/{{data_source}}/connections/{{connection}} 1090 | 1091 | #### Headers 1092 | 1093 | - Content-Type (string, required) - application/json 1094 | 1095 | #### Path Parameters 1096 | 1097 | - data_source (string, required) - Data source 1098 | - connection (integer, required) - Connection identifier 1099 | 1100 | #### Query Parameters 1101 | 1102 | - token (string, required) - Auth Token 1103 | 1104 | #### Request Body 1105 | 1106 | **@TODO** 1107 | 1108 | ```json 1109 | { 1110 | "parentIdentifier": "ROOT", 1111 | "name": "test", 1112 | "identifier": "1", 1113 | "activeConnections": 0, 1114 | "protocol": "rdp", 1115 | "parameters": { 1116 | "port": "", 1117 | "read-only": "", 1118 | "swap-red-blue": "", 1119 | "cursor": "", 1120 | "color-depth": "", 1121 | "clipboard-encoding": "", 1122 | "disable-copy": "", 1123 | "disable-paste": "", 1124 | "dest-port": "", 1125 | "recording-exclude-output": "", 1126 | "recording-exclude-mouse": "", 1127 | "recording-include-keys": "", 1128 | "create-recording-path": "", 1129 | "enable-sftp": "", 1130 | "sftp-port": "", 1131 | "sftp-server-alive-interval": "", 1132 | "enable-audio": "", 1133 | "security": "", 1134 | "disable-auth": "", 1135 | "ignore-cert": "", 1136 | "gateway-port": "", 1137 | "server-layout": "", 1138 | "timezone": "", 1139 | "console": "", 1140 | "width": "", 1141 | "height": "", 1142 | "dpi": "", 1143 | "resize-method": "", 1144 | "console-audio": "", 1145 | "disable-audio": "", 1146 | "enable-audio-input": "", 1147 | "enable-printing": "", 1148 | "enable-drive": "", 1149 | "create-drive-path": "", 1150 | "enable-wallpaper": "", 1151 | "enable-theming": "", 1152 | "enable-font-smoothing": "", 1153 | "enable-full-window-drag": "", 1154 | "enable-desktop-composition": "", 1155 | "enable-menu-animations": "", 1156 | "disable-bitmap-caching": "", 1157 | "disable-offscreen-caching": "", 1158 | "disable-glyph-caching": "", 1159 | "preconnection-id": "", 1160 | "hostname": "", 1161 | "username": "", 1162 | "password": "", 1163 | "domain": "", 1164 | "gateway-hostname": "", 1165 | "gateway-username": "", 1166 | "gateway-password": "", 1167 | "gateway-domain": "", 1168 | "initial-program": "", 1169 | "client-name": "", 1170 | "printer-name": "", 1171 | "drive-name": "", 1172 | "drive-path": "", 1173 | "static-channels": "", 1174 | "remote-app": "", 1175 | "remote-app-dir": "", 1176 | "remote-app-args": "", 1177 | "preconnection-blob": "", 1178 | "load-balance-info": "", 1179 | "recording-path": "", 1180 | "recording-name": "", 1181 | "sftp-hostname": "", 1182 | "sftp-host-key": "", 1183 | "sftp-username": "", 1184 | "sftp-password": "", 1185 | "sftp-private-key": "", 1186 | "sftp-passphrase": "", 1187 | "sftp-root-directory": "", 1188 | "sftp-directory": "" 1189 | }, 1190 | "attributes": { 1191 | "max-connections": "", 1192 | "max-connections-per-user": "", 1193 | "weight": "", 1194 | "failover-only": "", 1195 | "guacd-port": "", 1196 | "guacd-encryption": "", 1197 | "guacd-hostname": "" 1198 | } 1199 | } 1200 | ``` 1201 | 1202 | ### Response 1203 | 1204 | #### Status Code 1205 | 1206 | - 204 - No Content 1207 | 1208 | #### Response Body 1209 | 1210 | This request does not return a response body. 1211 | 1212 | --- 1213 | 1214 | ## Update Telnet Connection 1215 | 1216 | Updates Telnet connection. 1217 | 1218 | 1219 | ### PUT /api/session/data/{{data_source}}/connections/{{connection}} 1220 | 1221 | #### Headers 1222 | 1223 | - Content-Type (string, required) - application/json 1224 | 1225 | #### Path Parameters 1226 | 1227 | - data_source (string, required) - Data source 1228 | - connection (integer, required) - Connection identifier 1229 | 1230 | #### Query Parameters 1231 | 1232 | - token (string, required) - Auth Token 1233 | 1234 | #### Request Body 1235 | 1236 | **@TODO** 1237 | 1238 | ```json 1239 | { 1240 | "parentIdentifier": "ROOT", 1241 | "name": "test", 1242 | "identifier": "1", 1243 | "activeConnections": 0, 1244 | "protocol": "telnet", 1245 | "parameters": { 1246 | "port": "", 1247 | "read-only": "", 1248 | "swap-red-blue": "", 1249 | "cursor": "", 1250 | "color-depth": "", 1251 | "clipboard-encoding": "", 1252 | "disable-copy": "", 1253 | "disable-paste": "", 1254 | "dest-port": "", 1255 | "recording-exclude-output": "", 1256 | "recording-exclude-mouse": "", 1257 | "recording-include-keys": "", 1258 | "create-recording-path": "", 1259 | "enable-sftp": "", 1260 | "sftp-port": "", 1261 | "sftp-server-alive-interval": "", 1262 | "enable-audio": "", 1263 | "color-scheme": "", 1264 | "font-size": "", 1265 | "scrollback": "", 1266 | "backspace": "", 1267 | "terminal-type": "", 1268 | "create-typescript-path": "", 1269 | "hostname": "", 1270 | "username": "", 1271 | "password": "", 1272 | "username-regex": "", 1273 | "password-regex": "", 1274 | "login-success-regex": "", 1275 | "login-failure-regex": "", 1276 | "font-name": "", 1277 | "typescript-path": "", 1278 | "typescript-name": "", 1279 | "recording-path": "", 1280 | "recording-name": "" 1281 | }, 1282 | "attributes": { 1283 | "max-connections": "", 1284 | "max-connections-per-user": "", 1285 | "weight": "", 1286 | "failover-only": "", 1287 | "guacd-port": "", 1288 | "guacd-encryption": "", 1289 | "guacd-hostname": "" 1290 | } 1291 | } 1292 | ``` 1293 | 1294 | ### Response 1295 | 1296 | #### Status Code 1297 | 1298 | - 204 - No Content 1299 | 1300 | #### Response Body 1301 | 1302 | This request does not return a response body. 1303 | 1304 | --- 1305 | 1306 | ## Update Kubernetes Connection 1307 | 1308 | Updates Kubernetes connection. 1309 | 1310 | 1311 | ### PUT /api/session/data/{{data_source}}/connections/{{connection}} 1312 | 1313 | #### Headers 1314 | 1315 | - Content-Type (string, required) - application/json 1316 | 1317 | #### Path Parameters 1318 | 1319 | - data_source (string, required) - Data source 1320 | - connection (integer, required) - Connection identifier 1321 | 1322 | #### Query Parameters 1323 | 1324 | - token (string, required) - Auth Token 1325 | 1326 | #### Request Body 1327 | 1328 | **@TODO** 1329 | 1330 | ```json 1331 | { 1332 | "parentIdentifier": "ROOT", 1333 | "name": "test", 1334 | "identifier": "1", 1335 | "activeConnections": 0, 1336 | "protocol": "kubernetes", 1337 | "parameters": { 1338 | "port": "", 1339 | "read-only": "", 1340 | "swap-red-blue": "", 1341 | "cursor": "", 1342 | "color-depth": "", 1343 | "clipboard-encoding": "", 1344 | "disable-copy": "", 1345 | "disable-paste": "", 1346 | "dest-port": "", 1347 | "recording-exclude-output": "", 1348 | "recording-exclude-mouse": "", 1349 | "recording-include-keys": "", 1350 | "create-recording-path": "", 1351 | "enable-sftp": "", 1352 | "sftp-port": "", 1353 | "sftp-server-alive-interval": "", 1354 | "enable-audio": "", 1355 | "use-ssl": "", 1356 | "ignore-cert": "", 1357 | "color-scheme": "", 1358 | "font-size": "", 1359 | "scrollback": "", 1360 | "backspace": "", 1361 | "create-typescript-path": "", 1362 | "hostname": "", 1363 | "ca-cert": "", 1364 | "namespace": "", 1365 | "pod": "", 1366 | "container": "", 1367 | "client-cert": "", 1368 | "client-key": "", 1369 | "font-name": "", 1370 | "typescript-path": "", 1371 | "typescript-name": "", 1372 | "recording-path": "", 1373 | "recording-name": "" 1374 | }, 1375 | "attributes": { 1376 | "max-connections": "", 1377 | "max-connections-per-user": "", 1378 | "weight": "", 1379 | "failover-only": "", 1380 | "guacd-port": "", 1381 | "guacd-encryption": "", 1382 | "guacd-hostname": "" 1383 | } 1384 | } 1385 | ``` 1386 | 1387 | ### Response 1388 | 1389 | #### Status Code 1390 | 1391 | - 204 - No Content 1392 | 1393 | #### Response Body 1394 | 1395 | This request does not return a response body. 1396 | 1397 | --- 1398 | 1399 | ## Delete Connection 1400 | 1401 | Deletes given connection. 1402 | 1403 | 1404 | ### DELETE /api/session/data/{{data_source}}/connections/{{connection}} 1405 | 1406 | #### Headers 1407 | 1408 | None. 1409 | 1410 | #### Path Parameters 1411 | 1412 | - data_source (string, required) - Data source 1413 | - connection (integer, required) - Connection identifier 1414 | 1415 | #### Query Parameters 1416 | 1417 | - token (string, required) - Auth token 1418 | 1419 | #### Request Body 1420 | 1421 | None. 1422 | 1423 | ### Response 1424 | 1425 | #### Status Code 1426 | 1427 | - 204 - No Content 1428 | 1429 | #### Response Body 1430 | 1431 | This request does not return a response body. 1432 | 1433 | --- 1434 | 1435 | [Back to Top](#connections) 1436 | --------------------------------------------------------------------------------