Skip to main content
Get all currently active sessions.
External DocumentationTo learn more, visit the CyberArk documentation.

Basic Parameters

ParameterDescription
From TimeFilter live sessions that started after the specified time stamp.
Safe NameFilter live sessions that use accounts from a specific safe.
SearchFilter records by properties that contain the specified search text.
SortThe property by which to sort the retrieved results.
To TimeFilter live sessions that started before the specified time stamp.

Advanced Parameters

ParameterDescription
ActivitiesFilter live sessions by specified activity IDs.
LimitThe maximum number of items to retrieve per request (zero-based).
OffsetThe index of the first result to retrieve.

Example Output

{
  "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>
}

Workflow Library Example

List Active Sessions with Cyberark and Send Results Via Email
Workflow LibraryPreview this Workflow on desktop
I