Skip to content

Latest commit

 

History

History
776 lines (506 loc) · 13.5 KB

File metadata and controls

776 lines (506 loc) · 13.5 KB

Users

Manage users.

Table of Contents

List Users

List users.

GET /api/session/data/{{data_source}}/users

Headers

None.

Path Parameters

  • data_source (string, required) - Data source

Query Parameters

  • token (string, required) - Auth token

Request Body

None.

Response

Status Code

  • 200 - OK

Response Body

@TODO


Details of User

Details of user.

GET /api/session/data/{{data_source}}/users/{{username}}

Headers

None.

Path Parameters

  • data_source (string, required) - Data source
  • username (string, required) - Username

Query Parameters

  • token (string, required) - Auth Token

Request Body

None.

Response

Status Code

  • 200 - OK

Response Body

@TODO


Details of Self

Details of token owner.

GET /api/session/data/{{data_source}}/self

Headers

None.

Path Parameters

  • data_source (string, required) - Data source

Query Parameters

  • token (string, required) - Auth token

Request Body

None.

Response

Status Code

  • 200 - OK

Response Body

@TODO


Details of User Permissions

Details of user permissions.

GET /api/session/data/{{data_source}}/users/{{username}}/permissions

Headers

None.

Path Parameters

  • data_source (string, required) - Data source
  • username (string, required) - Username

Query Parameters

  • token (string, required) - Auth Token

Request Body

None.

Response

Status Code

  • 200 - OK

Response Body

@TODO


Details of User Effective Permissions

Details of user effective permissions.

GET /api/session/data/{{data_source}}/users/{{username}}/effectivePermissions

Headers

None.

Path Parameters

  • data_source (string, required) - Data source
  • username (string, required) - Username

Query Parameters

  • token (string, required) - Auth Token

Request Body

None.

Response

Status Code

  • 200 - OK

Response Body

@TODO


Details of User Groups

Details of user groups.

GET /api/session/data/{{data_source}}/users/{{username}}/userGroups

Headers

None.

Path Parameters

  • data_source (string, required) - Data source
  • username (string, required) - Username

Query Parameters

  • token (string, required) - Auth Token

Request Body

None.

Response

Status Code

  • 200 - OK

Response Body

@TODO


Details of User History

Details of user history.

GET /api/session/data/{{data_source}}/users/{{username}}/history

Headers

None.

Path Parameters

  • data_source (string, required) - Data source
  • username (string, required) - Username

Query Parameters

  • token (string, required) - Auth Token

Request Body

None.

Response

Status Code

  • 200 - OK

Response Body

@TODO


Assign User to User Groups

Assign user to user groups.

PATCH /api/session/data/{{data_source}}/users/{{username}}/userGroups

Headers

  • Content-Type (string, required) - application/json

Path Parameters

  • data_source (string, required) - Data source
  • username (string, required) - Username

Query Parameters

  • token (string, required) - Auth Token

Request Body

Body must be json-patch format.

[
  {
    "op": "add",
    "path": "/",
    "value": "{{user_group}}"
  }
]

Response

Status Code

  • 204 - No Content

Response Body

This request does not return a response body.


Revoke User from User Groups

Revoke user from user groups.

PATCH /api/session/data/{{data_source}}/users/{{username}}/userGroups

Headers

  • Content-Type (string, required) - application/json

Path Parameters

  • data_source (string, required) - Data source
  • username (string, required) - Username

Query Parameters

  • token (string, required) - Auth Token

Request Body

Body must be json-patch format.

[
  {
    "op": "remove",
    "path": "/",
    "value": "{{user_group}}"
  }
]

Response

Status Code

  • 204 - No Content

Response Body

This request does not return a response body.


Assign User to Connections

Assign user to connections.

PATCH /api/session/data/{{data_source}}/users/{{username}}/permissions

Headers

  • Content-Type (string, required) - application/json

Path Parameters

  • data_source (string, required) - Data source
  • username (string, required) - Username

Query Parameters

  • token (string, required) - Auth Token

Request Body

Body must be json-patch format.

[
  {
    "op": "add",
    "path": "/connectionPermissions/{{connectionId}}",
    "value": "READ"
  }
]

You may also include connection groups (folders), and must if the connection that you wish to allow access to is within a connection group.

[
  {
    "op": "add",
    "path": "/connectionGroupPermissions/{{connectionGroupId}}",
    "value": "READ"
  }
]

Response

Status Code

  • 204 - No Content

Response Body

This request does not return a response body.


Revoke User from Connections

Revoke user from connections.

PATCH /api/session/data/{{data_source}}/users/{{username}}/permissions

Headers

  • Content-Type (string, required) - application/json

Path Parameters

  • data_source (string, required) - Data source
  • username (string, required) - Username

Query Parameters

  • token (string, required) - Auth Token

Request Body

Body must be json-patch format.

[
  {
    "op": "remove",
    "path": "/connectionPermissions/{{connectionId}}",
    "value": "READ"
  }
]

You may also include connection groups (folders)

[
  {
    "op": "remove",
    "path": "/connectionGroupPermissions/{{connectionGroupId}}",
    "value": "READ"
  }
]

Response

Status Code

  • 204 - No Content

Response Body

This request does not return a response body.


Update User Password

Updates user password.

PUT /api/session/data/{{data_source}}/users/{{username}}/password

Headers

  • Content-Type (string, required) - application/json

Path Parameters

  • data_source (string, required) - Data source
  • username (string, required) - Username

Query Parameters

  • token (string, required) - Auth Token

Request Body

  • oldPassword (string, required) - Old password
  • newPassword (string, required) - New password
{
  "oldPassword": "{{oldPassword}}",
  "newPassword": "{{newPassword}}"
}

Response

Status Code

  • 204 - No Content

Response Body

This request does not return a response body.


Update User

Updates user.

PUT /api/session/data/{{data_source}}/users/{{username}}

Headers

  • Content-Type (string, required) - application/json

Path Parameters

  • data_source (string, required) - Data source
  • username (string, required) - Username

Query Parameters

  • token (string, required) - Auth Token

Request Body

@TODO

{
  "username": "{{username}}",
  "attributes": {
    "guac-email-address": null,
    "guac-organizational-role": null,
    "guac-full-name": null,
    "expired": "",
    "timezone": null,
    "access-window-start": "",
    "guac-organization": null,
    "access-window-end": "",
    "disabled": "",
    "valid-until": "",
    "valid-from": ""
  }
}

Response

Status Code

  • 204 - No Content

Response Body

This request does not return a response body.


Create User

Creates a user.

POST /api/session/data/{{data_source}}/users

Headers

  • Content-Type (string, required) - application/json

Path Parameters

  • data_source (string, required) - Data source

Query Parameters

  • token (string, required) - Auth Token

Request Body

@TODO

{
  "username": "test",
  "password": "pass",
  "attributes": {
    "disabled": "",
    "expired": "",
    "access-window-start": "",
    "access-window-end": "",
    "valid-from": "",
    "valid-until": "",
    "timezone": null,
    "guac-full-name": "",
    "guac-organization": "",
    "guac-organizational-role": ""
  }
}

Response

Status Code

  • 200 - OK

Response Body

@TODO

Delete User

Delete user.

DELETE /api/session/data/{{data_source}}/users/{{username}}

Headers

None.

Path Parameters

  • data_source (string, required) - Data source
  • username (integer, required) - Username

Query Parameters

  • token (string, required) - Auth token

Request Body

None.

Response

Status Code

  • 204 - No Content

Response Body

This request does not return a response body.


Back to Top