Push Notifications

Data Structures

PushNotificationModel

Attribute	Type	Required	Description
id	string		Read-only. Unique notification identifier.
event_name	string {access_request_accepted, access_request_pending, access_request_rejected, session_ai_summary, session_finish, session_inject_close, session_inject_open, session_live_analysis, session_ml, session_regexp, session_start, session_sudo, session_waiting}		Read-only. Name of event that triggered the notification.
event_type	string {access_request, session}		Read-only. Type of event that triggered the notification.
event_transport	string {mail, push, slack}		Read-only. Transport used to deliver the notification.
event_message	string		Read-only. Additional message associated with the event.
event_arguments	string		Read-only; expensive to use. Additional arguments necessary to display the event.
occurred_at	datetime		Read-only. Time when the event occurred.
recipient_id	string		Read-only. ID of the user who is the recipient of the notification.
access_request_id	string	If event_type == access_request	Read-only. Access request identifier.
access_request_reason	string	If event_type == access_request	Read-only. Access request reason.
access_request_status	string {expired, granted, pending, rejected}	If event_type == access_request	Read-only; expensive to use. Access request status.
access_request_type	string {immediate, scheduled, preview}	If event_type == access_request	Read-only. Access request type.
access_request_immediate_interval	number	If event_type == access_request	Read-only; expensive to use. Access request immediate interval (1-24 hours).
access_request_starts_at	datetime	If event_type == access_request	Read-only. When access request starts.
access_request_expires_at	datetime	If event_type == access_request	Read-only. When access request expires.
access_request_created_at	datetime	If event_type == access_request	Read-only. When access request was created.
access_request_reject_reason	string	If event_name == access_request_rejected	Read-only. Access request rejection reason.
session_id	string	If event_type == session	Read-only. Session identifier.
session_source_ip	string	If event_type == session	Read-only. Session source IP address.
session_destination_ip	string	If event_type == session	Read-only. Session destination IP address.
session_destination_port	number	If event_type == session	Read-only. Session destination port.
session_login_reason	string	If event_type == session	Read-only. Session login reason.
session_started_at	datetime	If event_type == session	Read-only. When session started.
session_finished_at	datetime	If event_type == session	Read-only. When session finished.
session_analysis_peak_severity	string {unknown, low, medium, high}	If event_type == session	Read-only. Peak severity reported by live LLM session analysis.
session_ml_threat_level	number	If event_type == session	Read-only. Session ML threat level.
session_ml_threat_level_max	number	If event_type == session	Read-only. Session ML threat level maximum.
session_ml_threat_level_min	number	If event_type == session	Read-only. Session ML threat level minimum.
session_summary	string	If event_type == session	Read-only. AI-generated summary of the session.
session_summary_key_risks	object-array	If event_type == session	Read-only. Session summary key risks.
session_summary_status	string {unprocessed, pending, processing, succeeded, failed}	If event_type == session	Read-only. Current processing state of the AI summarizer.
session_scores	object-array	If event_type == session	Read-only. Session scores.
account_id	string		Read-only. Account identifier.
account_name	string		Read-only. Account name.
account_login	string		Read-only. Account login.
account_domain	string		Read-only. Account domain.
listener_id	string		Read-only. Listener identifier.
listener_name	string	If event_type == session	Read-only. Listener name.
pool_id	string		Read-only. Pool identifier.
pool_name	string		Read-only. Pool name.
protocol	string {checkout, http, modbus, mysql, oracle, pgsql, rdp, ssh, tcp, tds, telnet, tn3270, tn5250, vnc}		Read-only. Protocol used.
safe_id	string		Read-only. Safe identifier.
safe_name	string		Read-only. Safe name.
server_id	string		Read-only. Server identifier.
server_name	string		Read-only. Server name.
user_id	string		Read-only. User identifier.
user_domain	string		Read-only. User domain.
user_full_name	string		Read-only. User full name.
user_name	string		Read-only. User name.
user_organization	string		Read-only. User organization.
user_extra_id	string		Read-only. ID of another user related to the notification: for example user who joined the session.
user_extra_domain	string		Read-only. Extra user domain.
user_extra_name	string		Read-only. Extra user name.
user_extra_organization	string		Read-only. Extra user organization.
policies	object-array	If event_name == session_ai_summary | session_live_analysis | session_ml | session_regexp | session_sudo	Read-only. List of policies that triggered the notification.
webclient	boolean		Read-only; expensive to use. Is the access available via the web client or was the session established using the web client?
secret_id	string		Read-only. Secret identifier.
secret_name	string		Read-only. Secret name.
secret_login	string		Read-only. Secret login.
secret_domain	string		Read-only. Secret domain.
secret_description	string		Read-only. Secret description.
secret_uris	string-array		Read-only. Secret URIs.
collection_id	string		Read-only. Collection identifier.
collection_name	string		Read-only. Collection name.

Get Push Notification Object Specification

Request

Method	GET
Path	/api/v2/objspec/push_notification

GET /api/v2/objspec/push_notification

Example Request

curl -s -k -X GET \
  -H 'Authorization: <token>' \
  'https://10.31.135.179/api/v2/objspec/push_notification'

Response

{
    "result": "success",
    "push_notification": {
        "id": {
            "type": "string",
            "readonly": true,
            "filterable": true
        },
        "event_name": {
            "type": "string",
            "description": "Name of event that triggered the notification",
            "readonly": true,
            "values": [
                "access_request_accepted", "access_request_pending", "access_request_rejected",
                "session_ai_summary", "session_finish", "session_inject_close",
                "session_inject_open", "session_ml", "session_regexp",
                "session_start", "session_waiting"
            ],
            "filterable": true
        },
        "event_type": {
            "type": "string",
            "description": "Type of event that triggered the notification",
            "readonly": true,
            "values": ["access_request", "session"],
            "filterable": true
        },
        "event_transport": {
            "type": "string",
            "description": "Transport used to deliver the notification",
            "readonly": true,
            "values": ["mail", "push", "slack"],
            "filterable": true
        },
        "event_message": {
            "type": "string",
            "description": "Additional message associated with the event",
            "readonly": true,
            "filterable": true
        },
        "occurred_at": {
            "type": "string",
            "description": "Time when the event occurred",
            "db-subtype": "timestamp",
            "readonly": true,
            "filterable": true
        },
        "session_summary": {
            "type": "string",
            "description": "AI-generated summary of the session.",
            "readonly": true,
            "filterable": true
        }
    }
}

List Push Notifications

Request

Method	GET
Path	/api/v2/notification/push

GET /api/v2/notification/push

Example Request

curl -s -k -X GET \
  -H 'Authorization: <token>' \
  'https://10.31.135.179/api/v2/notification/push'

Response

{
    "result": "success",
    "push_notification": [
        {
            "id": "notif123",
            "event_name": "session_ai_summary",
            "event_type": "session",
            "event_transport": "push",
            "event_message": "AI summary generated for session",
            "occurred_at": "2025-01-15T14:30:00Z",
            "session_id": "session_456",
            "session_summary": "User performed database maintenance tasks with elevated privileges.",
            "user_name": "john.doe"
        }
    ]
}

Get Push Notification by ID

Request

Method	GET
Path	/api/v2/notification/push/<id>

GET /api/v2/notification/push/<id>

Example Request

curl -s -k -X GET \
  -H 'Authorization: <token>' \
  'https://10.31.135.179/api/v2/notification/push/notif123'

Response

{
    "result": "success",
    "push_notification": [
        {
            "id": "notif123",
            "event_name": "access_request_pending",
            "event_type": "access_request",
            "event_transport": "push",
            "occurred_at": "2025-01-15T14:30:00Z",
            "access_request_id": "ar789",
            "access_request_status": "pending",
            "user_name": "jane.smith",
            "safe_name": "Production Safe"
        }
    ]
}