Get active sessions

This method returns details of active sessions.

URL

 

Make sure there are no spaces in the URL.

The following characters are not supported in URL values: + & %

 

 

https://<IIS_Server_Ip>/PasswordVault/api/LiveSessions?Limit={#}&Sort={Recording property}&offset={#}&Search={Search text}&Safe={Search text}&FromTime={UTC}&ToTime={UTC}&Activities={text}

The following values can be added in the URL. None of them are mandatory.

Parameter

Limit

Type

Integer

Description

Determines the number of lives sessions that are returned in the list.

The maximum value is defined in the MaxRecords property in Options à Privileged Session Management à General Setting à Search Properties.

Valid values

A positive value greater than 0

Default

25

Parameter

Sort

Type

String

Description

The sort can be done by each property on the recording file:

RiskScore
FileName
SafeName
FolderName
PSMVaultUserName
FromIP
RemoteMachine
Client
Protocol
AccountUserName
AccountAddress
AccountPlatformID
PSMStartTime
TicketID

The sort can be in ascending or descending order. To sort in descending order, specify "-" (dash) before the recording property by which to sort.

Default

Descending according to StartTime

Parameter

Offset

Type

Integer

Description

Determines which recording results will be returned, according to a specific place in the returned list. This value defines the recording's place in the list and how many results will be skipped.

Valid values

A positive value greater than 0

Default

0

Parameter

Search

Type

String

Description

Returns lives sessions that are filtered by properties that contain the specified search text.

Parameter

Safe

Type

String

Description

Returns lives sessions that use accounts from a specific Safe.

Parameter

FromTime

Type

Integer

Description

Returns lives sessions from a specific date.

Parameter

ToTime

Type

Integer

Description

Returns lives sessions before a specific date.

Parameter

Activities

Type

String

Description

Returns lives sessions with specific activities.

Resource information

HTTP method

GET

Content type

application/json

Header parameter

Parameter

Authorization

Type

String

Description

The token that identifies the session, encoded in BASE 64.

Valid values

A session token that was returned from the “Logon” method.

Body parameters

None

Result

 
{
  "LiveSessions": [
    {
      "CanTerminate": <true/false>,
      "CanMonitor": <true/false>,
      "CanSuspend": <true/false>,
      "SessionID": "<session id>",
      "SessionGuid": "<session guid>",
      "SafeName": "<Safe name>",
      "FolderName": "<folder>",
      "IsLive": <true/false>,
      "FileName": "<file name>",
      "Start": <timestamp>,
      "End": <timestamp>,
      "Duration": <seconds>,
      "User": "<user>",
      "RemoteMachine": "<IP address>",
      "ProtectionDate": <timestamp>,
      "ProtectedBy": "User who protected the recording",
      "ProtectionEnabled": <true/false>,
      "AccountUsername": "<user>",
      "AccountPlatformID": "<platform ID>",
      "AccountAddress": "<timestamp>",
      "PIMSuCommand": "<command>",
      "PIMSuCWD": "<Current Working Directory>",
      "ConnectionComponentID": "<ID>",
      "PSMRecordingEntity": "<Recording entity>",
      "TicketID": "<ID>",
      "FromIP": "<timestamp>",
      "Protocol": "<protocol>",
      "Client": "<client>",
      "RiskScore": <score>,
      "Severity": "<severity>",
      "IncidentDetails": <details>,
      "RawProperties": {
        "Address": "<IP address>",
        "ConnectionComponentID": "ID",
        "DeviceType": "device type",
        "EntityVersion": "<version>",
        "ExpectedRecordingsList": "<list>",
        "PolicyID": "<policy ID>",
        "ProviderID": "<ID>",
        "PSMClientApp": "<PSMClientApp>",
        "PSMPasswordID": "<ID>",
        "PSMProtocol": "<protocol>",
        "PSMRecordingEntity": "<PSMRecordingEntity>",
        "PSMRemoteMachine": "<timestamp>",
        "PSMSafeID": "<ID>",
        "PSMSourceAddress": "<timestamp>",
        "PSMStartTime": "<timestamp>",
        "PSMStatus": "Placeholder",
        "PSMVaultUserName": "<user>",
        "UserName": "<user>",
        "Safe": "<Safe>",
        "Folder": "<folder>",
        "Name": "<session name>"
      },
      "RecordingFiles": [<files>],
      "RecordedActivities": [<activities>],
      "VideoSize": <size>,
      "TextSize": <size>,
      "DetailsUrl": "<URL>"
    }
  ],
  "Total": <total>
}

Return codes

For a complete list of return codes, see Return Codes.