Skip to main content
Version: v41

connection

A connection object

idstring<uuid>
Example: eef4aefc-d64e-4c2c-aba4-4914c86ce059
proxy_idstring<uuid>
Example: eef4aefc-d64e-4c2c-aba4-4914c86ce059
typestring

Possible values: [SSH, RDP]

authentication_methodstring[]

Possible values: [CERT, PUBKEY, PASSPHRASE, PROMPTED_PASSPHRASE, UNKNOWN]

user_data object
idstring<uuid>
Example: eef4aefc-d64e-4c2c-aba4-4914c86ce059
display_namestring
Example: user@domain.com
user_roles object[]
  • Array [
  • idstring<uuid>
    Example: eef4aefc-d64e-4c2c-aba4-4914c86ce059
    namestring
    Example: example-admins
  • ]
  • target_host_data object
    idstring<uuid>
    Example: eef4aefc-d64e-4c2c-aba4-4914c86ce059
    common_namestring
    Example: linux-host
    target_host_addressstring
    Example: 123.123.123.123
    target_host_accountstring
    Example: dbuser
    target_host_roles object[]
  • Array [
  • idstring<uuid>
    Example: eef4aefc-d64e-4c2c-aba4-4914c86ce059
    namestring
    Example: example-admins
  • ]
  • remote_addressstring
    Example: 123.123.123.123
    connectedstring<date-time>
    Example: 2017-01-01T15:05:05Z
    disconnectedstring<date-time>
    Example: 2017-01-01T15:05:05Z
    durationstring

    Connection duration in ISO8601 format.

    Example: PT00:15:38
    statusstring

    Possible values: [CONNECTED, DISCONNECTED, TERMINATING, TERMINATED, CONNMGR_TIMEOUT, CONNMGR_CLIENT_LOST]

    last_activitystring<date-time>

    The time when connection was last interacted with by user.

    Example: 2017-01-01T15:05:05Z
    bytes_ininteger
    Example: 123456
    bytes_outinteger
    Example: 12345678
    force_disconnectstring<date-time>

    The connection termination was requested

    Example: 2017-01-01T15:05:05Z
    createdstring<date-time>

    When the object was created

    Example: 2017-01-01T15:05:05Z
    updatedstring<date-time>

    When the object was updated

    Example: 2017-01-01T15:05:05Z
    updated_bystring<uuid>

    Id of the user who updated the object

    Example: eef4aefc-d64e-4c2c-aba4-4914c86ce059
    audit_enabledboolean

    Wether connection is audited or not.

    access_group_idstring<uuid>

    The access group ID

    Example: eef4aefc-d64e-4c2c-aba4-4914c86ce059
    trail object

    The trail metadata for audited connection. Not available for connection listing.

    connection_idstring<uuid>
    host_idstring<uuid>
    user_idstring<uuid>
    protocolstring
    channels object[]
  • Array [
  • idstring
    typestring

    Type description for the channel.

    bytes_client_to_serverinteger

    Bytes transferred from client to server.

    bytes_server_to_clientinteger

    Bytes transferred from server to client.

    protocol_file object
    idstring<uuid>
    namestring
    offsetinteger
    directioninteger

    From server to client = 1, from client to server = 2

    open_timestring<date-time>
    close_timestring<date-time>
    payload_sizeinteger
    closedboolean
    statusstring

    Possible values: [OK, PERMISSION_DENIED, TIMEOUT, MISSING, LENGTH_MISMATCH, CHECKSUM_MISMATCH, DECRYPTION_ERROR, STORAGE_UNDEFINED, ID_UNDEFINED, UNCLEAN_CLOSE, GENERIC_ERROR, ONGOING]

    transferred_files object[]
  • Array [
  • idstring<uuid>
    namestring
    offsetinteger
    directioninteger

    From server to client = 1, from client to server = 2

    open_timestring<date-time>
    close_timestring<date-time>
    payload_sizeinteger
    closedboolean
    statusstring

    Possible values: [OK, PERMISSION_DENIED, TIMEOUT, MISSING, LENGTH_MISMATCH, CHECKSUM_MISMATCH, DECRYPTION_ERROR, STORAGE_UNDEFINED, ID_UNDEFINED, UNCLEAN_CLOSE, GENERIC_ERROR, ONGOING]

  • ]
  • ]
  • index_statusstring

    describes the indexing status of the connection

    Possible values: [NOT_INDEXED, INDEXING, INDEXED, ERROR]

    access_roles object[]

    The access roles set for this connection

  • Array [
  • addedstring<date-time>
    idstring<uuid>

    Role ID

    namestring

    Role name

  • ]
  • tagsstring[]
    connection
    {
    "id": "eef4aefc-d64e-4c2c-aba4-4914c86ce059",
    "proxy_id": "eef4aefc-d64e-4c2c-aba4-4914c86ce059",
    "type": "SSH",
    "authentication_method": [
    "CERT"
    ],
    "user_data": {
    "id": "eef4aefc-d64e-4c2c-aba4-4914c86ce059",
    "display_name": "user@domain.com"
    },
    "user_roles": [
    {
    "id": "eef4aefc-d64e-4c2c-aba4-4914c86ce059",
    "name": "example-admins"
    }
    ],
    "target_host_data": {
    "id": "eef4aefc-d64e-4c2c-aba4-4914c86ce059",
    "common_name": "linux-host"
    },
    "target_host_address": "123.123.123.123",
    "target_host_account": "dbuser",
    "target_host_roles": [
    {
    "id": "eef4aefc-d64e-4c2c-aba4-4914c86ce059",
    "name": "example-admins"
    }
    ],
    "remote_address": "123.123.123.123",
    "connected": "2017-01-01T15:05:05Z",
    "disconnected": "2017-01-01T15:05:05Z",
    "duration": "PT00:15:38",
    "status": "CONNECTED",
    "last_activity": "2017-01-01T15:05:05Z",
    "bytes_in": 123456,
    "bytes_out": 12345678,
    "force_disconnect": "2017-01-01T15:05:05Z",
    "created": "2017-01-01T15:05:05Z",
    "updated": "2017-01-01T15:05:05Z",
    "updated_by": "eef4aefc-d64e-4c2c-aba4-4914c86ce059",
    "audit_enabled": true,
    "access_group_id": "eef4aefc-d64e-4c2c-aba4-4914c86ce059",
    "trail": {
    "connection_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "host_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "user_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "protocol": "string",
    "channels": [
    {
    "id": "string",
    "type": "string",
    "bytes_client_to_server": 0,
    "bytes_server_to_client": 0,
    "protocol_file": {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "name": "string",
    "offset": 0,
    "direction": 0,
    "open_time": "2024-07-29T15:51:28.071Z",
    "close_time": "2024-07-29T15:51:28.071Z",
    "payload_size": 0,
    "closed": true,
    "status": "OK"
    },
    "transferred_files": [
    {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "name": "string",
    "offset": 0,
    "direction": 0,
    "open_time": "2024-07-29T15:51:28.071Z",
    "close_time": "2024-07-29T15:51:28.071Z",
    "payload_size": 0,
    "closed": true,
    "status": "OK"
    }
    ]
    }
    ]
    },
    "index_status": "NOT_INDEXED",
    "access_roles": [
    {
    "added": "2024-07-29T15:51:28.071Z",
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "name": "string"
    }
    ],
    "tags": [
    "string"
    ]
    }