Safes¶
directly regulates user access to monitored servers. It specifies available protocols’ features, policies and other details concerning users and servers relations.
Data structures¶
| Parameter | Type | Description |
|---|---|---|
| id | string | Read only |
| rdp | SafeRDPAttributes | Safe settings for protocol == rdp |
| ssh | SafeSSHAttributes | Safe settings for protocol == sh |
| vnc | SafeVNCAttributes | Safe settings for protocol == vnc |
| name | string | Unique name. Required |
| webclient | bool | Enable connections via the browser |
| blocked | bool | |
| reason | string | The reason of the safe being blocked |
| login_reason | bool | Enable sending login reason for connection |
| require_confirmation | bool | Enable confirmation of each connection |
| confirmation_timeout | int | Min value = -2147483648, Max value = 2147483647 |
| note_access | string {none, read, write} | Access level to the notes |
| time_limit | int | Enable Session time limit in minutes |
| inactivity_limit | int | Enable Session inactivity limit in minutes |
| required_votes | int | How many voters will be voting for the access request |
| backup | string | Target destination for storing session data |
| users | string | Read only |
| Parameter | Type | Description |
|---|---|---|
| audio | bool | Audio input redirection. Default value == true |
| clipboard | bool | Clipboard redirection. Default value == true |
| depth | int{8,16,24,32} | Max. color depth |
| device | bool | Device redirection. Default value == true |
| driver_dvc | bool | Default value == false” |
| multimedia | bool | Multimedia redirection. Default value == true |
| resolution | Resolution | Max. resolution |
| sound | bool | Sound redirection. Default value == true |
| suspend | bool | Enable content to not be available for viewing when the user minimizes its client application. |
| Parameter | Type | Description |
|---|---|---|
| session | bool | Default value == true |
| port_forwarding | bool | Default value == true |
| terminal | bool | Default value == true |
| environment | bool | Default value == true |
| x11 | bool | Default value == true |
| agent_forwarding | bool | Default value == true |
| shell | bool | Default value == true |
| scp | bool | Default value == true |
| sftp | bool | Default value == true |
| ssh_exec | bool | Default value == true |
| Parameter | Type | Description |
|---|---|---|
| client_clip | bool | Enable a user to be allowed to paste text into the VNC server computer. Default value == true |
| server_clip | bool | Enabled a user to be allowed to copy and paste text from the VNC server computer into the user’s computer. Default value == true |
| Parameter | Type | Description |
|---|---|---|
| password_visible | bool | Allow a user to use Secret Checkout feature and view passwords in the User Portal. |
| position | int | mandatory, 0 or a negative value |
| safe_id | int |
|
| safe | Read only | |
| id | int | |
| name | string | |
| use_time_policy | bool |
| Parameter | Type | Description |
|---|---|---|
| account_id | int |
|
| account | Read only | |
| id | int | |
| name | string | |
| listener_id | int |
|
| listener | Read only | |
| id | int | |
| name | string |
Creating a safe¶
Request
| Method | POST
|
| Path | /api/system/safes
|
| Headers | Content-Type: Application/JSON
|
| Body | SafeModel
|
Possible Response
| Status | 201 CREATED
|
| Headers | Content-Type: Application/JSON
|
| Body | SafeModel
|
Possible Response
| Status | 400 BAD REQUEST
|
| Headers | Content-Type: Application/JSON
|
| Body | ValidationErrors
|
| Description | Validation didn’t pass. |
Retrieving safes list¶
Request
| Method | GET
|
| Path | /api/system/safes
|
Note
Results pagination
Every GET request, which returns a collection of objects can be optionally paginated. To achieve it add a pagination parameter to the request path:
/api/system/objects?page=3&page_size=10
| page | int |
| page_size | int |
Possible Response
| Status | 200 OK
|
| Headers | Content-Type: Application/JSON
|
| Body | [
SafeModel,
...
]
|
Retrieving a safe¶
Request
| Method | GET
|
| Path | /api/system/safes/:safe_id
|
Possible Response
| Status | 200 OK
|
| Headers | Content-Type: Application/JSON
|
| Body | SafeModel
|
Possible Response
| Status | 404 NOT FOUND
|
| Description | No safe with given id. |
Modifying a safe¶
Request
| Method | PUT, PATCH
|
| Path | /api/system/safes/:safe_id
|
Possible Response
| Status | 200 OK
|
| Headers | Content-Type: Application/JSON
|
| Body | SafeModel
|
Possible Response
| Status | 400 BAD REQUEST
|
| Headers | Content-Type: Application/JSON
|
| Body | SafeModel
|
Possible Response
| Status | 404 NOT FOUND
|
| Description | No safe with given id. |
Deleting a safe¶
Request
| Method | DELETE
|
| Path | /api/system/safes/:safe_id
|
Possible Response
| Status | 204 NO CONTENT
|
Possible Response
| Status | 404 NOT FOUND
|
| Description | Object with specified identifier was not found. |
Retrieving users allowed to manage selected safe¶
Request
| Method | GET
|
| Path | /api/system/safes/:safe_id/granted_users
|
Note
Results pagination
Every GET request, which returns a collection of objects can be optionally paginated. To achieve it add a pagination parameter to the request path:
/api/system/objects?page=3&page_size=10
| page | int |
| page_size | int |
Possible Response
| Status | 200 OK
|
| Headers | Content-Type: Application/JSON
|
| Body | [
{
'name': 'safename',
'id': :id
} , ...
] |
Granting management privileges¶
Request
| Method | POST
|
| Path | /api/system/safes/:safe_id/granted_users
|
| Body | {
''user_id'': :user_id
}
|
Possible Response
| Status | 201 CREATED
|
Revoking management privileges¶
Request
| Method | DELETE
|
| Path | /api/system/safes/:safe_id/granted_users/:safe_id
|
Possible Response
| Status | 204 NO CONTENT
|
Possible Response
| Status | 404 NOT FOUND
|
Safe members (account-safe-listener) management¶
Retrieving account-safe-listener assignments list¶
Request
| Method | GET
|
| Path | /api/system/safes/:safe_id/account_listeners
|
Note
Results pagination
Every GET request, which returns a collection of objects can be optionally paginated. To achieve it add a pagination parameter to the request path:
/api/system/objects?page=3&page_size=10
| page | int |
| page_size | int |
Possible Response
| Status | 200 OK
|
| Headers | Content-Type: Application/JSON
|
| Body | [
AccountSafeListenerAssignment,
...
]
|
Creating account-safe-listener assignment¶
Request
| Method | POST
|
| Path | /api/system/safes/:safe_id/account_listeners
|
| Body | AccountSafeListenerAssignment
|
Possible Response
| Status | 201 CREATED
|
| Headers | Content-Type: Application/JSON
|
| Body | AccountSafeListenerAssignment
|
Possible Response
| Status | 400 BAD REQUEST
|
| Headers | Content-Type: Application/JSON
|
| Body | ValidationErrors
|
Possible Response
| Status | 404 NOT FOUND
|
Deleting account-safe-listener assignment¶
Request
| Method | DELETE
|
| Path | /api/system/safes/:safe_id/account_listeners/:assoc_id
|
Possible Response
| Status | 204 NO CONTENT
|
Possible Response
| Status | 404 NOT FOUND
|