SessionInfo

SessionInfo
SessionInfo

Information related to Session.
Supported Filters : 'And', 'Or', 'Equals', 'NotEquals' and 'Contains'.
See the field description to know the filter types it supports.

JSON Example 
{
    "access_group_id": "6fd4638a-381f-4518-aed6-042aa3d9f14c",
    "agent_version": "7.12.0",
    "application_names": [
        "Calculator"
    ],
    "broker_user_id": "S-1-5-21-1111111111-2222222222-3333333333-500",
    "brokered_remotely": false,
    "client_data": {
        "address": "127.0.0.1",
        "location_id": "6bda20e66cda315084edc8b5c67f9cf1e3b0f4559ba990b1004a",
        "name": "EXAMPLE-CLIENT1",
        "type": "WINDOWS",
        "version": "5.4.0"
    },
    "desktop_pool_id": "0103796c-102b-4ed3-953f-3dfe3d23e0fe",
    "disconnected_time": 1582181947320,
    "farm_id": "0dbd14ba-5795-4141-9cec-128ff6d494b0",
    "id": "7cdd624f-37d1-46c1-ab96-695a5d13956f",
    "idle_duration": 60,
    "last_session_duration_ms": 116320,
    "machine_id": "a00eda55-708a-4f7d-8cbc-1d1b3a2b5f73",
    "rds_server_id": "6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed50",
    "resourced_remotely": false,
    "security_gateway_data": {
        "address": "127.0.0.1",
        "domain_name": "SECURE-GW.example.com",
        "location": "EXTERNAL"
    },
    "session_protocol": "PCOIP",
    "session_state": "CONNECTED",
    "session_type": "APPLICATION",
    "start_time": 1582181831000,
    "unauthenticated": false,
    "user_id": "S-1-5-21-1111111111-2222222222-3333333333-500"
}
string
access_group_id
Optional

Access group id associated with the session. For a non-RDS desktop session, this is the desktop pool's access group id. For an RDS desktop session, this is the RDS desktop pool's farm's access group id. For an application session, this is the application's farm's access group id.
Supported Filters : 'Equals'.

string
agent_version
Optional

Version of agent This property need not be set.
Supported Filters : 'Equals'.

array of string
application_names
Optional

Names of the applications launched in the session. It will be only set when session_type is APPLICATION.
Supported Filters : 'Contains'.

string
broker_user_id
Optional

User SID for the broker user associated with the session. It will be unset for non-broker sessions.
Supported Filters : 'Equals'.

boolean
brokered_remotely
Optional

Indicates whether the session is brokered from a remote pod. It is set only if the Horizon View agent where the session resides is version 6.0 or later.
Supported Filters : 'Equals'.

ClientData
client_data
Optional

client_data

string
desktop_pool_id
Optional

Unique desktop pool id for the session. This is unset if the session is not brokered through a desktop, such as for direct console access.
Supported Filters : 'Equals'.

integer As int64 As int64
disconnected_time
Optional

Epoch time in milli seconds, when the session was last disconnected. This will be unset if the session's machine has an error state, or if the session has never been disconnected.
Supported Filters : 'Equals'.

string
farm_id
Optional

Unique farm id for this RDS desktop or application session. This is unset if the session is not brokered through a farm, such as for application sessions or direct console access.
Supported Filters : 'Equals'.

string
id
Optional

Unique id representing a session.
Supported Filters : 'Equals'.

integer As int64 As int64
idle_duration
Optional

Idle time duration in minutes, indicating how long the end user of the session has been idle for. This property need not be set.
Supported Filters : 'Equals'.

integer As int64 As int64
last_session_duration_ms
Optional

Duration of the last connection period of the session in milli seconds. If the session is currently connected, this is the duration that the session has been in connected state. If the session is currently disconnected, this is the duration of its previous connection period. This will be unset on error.
Supported Filters : 'Equals'.

string
machine_id
Optional

Unique machine id for the session. This is unset for RDS Desktop or application sessions. If desktop pool id is unset, it is the id of registered un-managed physical machine.
Supported Filters : 'Equals'.

string
rds_server_id
Optional

Unique RDS server id for the RDS desktop or application session. This property need not be set.
Supported Filters : 'Equals'.

boolean
resourced_remotely
Optional

Indicates whether the session is running on remote pod resource.
Supported Filters : 'Equals'.

SecurityGatewayData
security_gateway_data
Optional

security_gateway_data

string
session_protocol
Optional

Protocol for the session. It will be unset for disconnected sessions.
Supported Filters : 'Equals'.

  • PCOIP: Display protocol is PCoIP.
  • RDP: Display protocol is RDP.
  • BLAST: Display protocol is BLAST.
  • CONSOLE: Display protocol is console.
  • UNKNOWN: Display protocol is unknown.
Possible values are : PCOIP, RDP, BLAST, CONSOLE, UNKNOWN,
string
session_state
Optional

State of session.
Supported Filters : 'Equals', 'NotEquals'.

  • CONNECTED: Session is connected
  • DISCONNECTED: Session is disconnected
  • PENDING: Session is pending
Possible values are : CONNECTED, DISCONNECTED, PENDING,
string
session_type
Optional

Type of session.
Supported Filters : 'Equals'.

  • DESKTOP: Desktop or RDS desktop session.
  • APPLICATION: Application session.
Possible values are : DESKTOP, APPLICATION,
integer As int64 As int64
start_time
Optional

Epoch time in milli seconds, when the session was originally logged in. The lifecycle of a session begins at login and ends at logout, with any number of connect and disconnect occurrences in between. The first connection time will be shortly after this time. This property need not be set.
Supported Filters : 'Equals'.

boolean
unauthenticated
Optional

Indicates whether the session is of unauthenticated access user. This property need not be set.
Supported Filters : 'Equals'.

string
user_id
Optional

Unique SID of the user logged into the session. It may not match the broker user id for non-SSO scenarios.
Supported Filters : 'Equals'.

Returned By