Class SecurityAlert
- Namespace
- Excalibur.Data.ElasticSearch.Security
- Assembly
- Excalibur.Data.ElasticSearch.dll
Represents a security alert generated by the monitoring system.
public sealed class SecurityAlert
- Inheritance
-
SecurityAlert
- Inherited Members
Constructors
SecurityAlert()
Initializes a new instance of the SecurityAlert class.
public SecurityAlert()
SecurityAlert(Guid, string, SecurityEventSeverity, string, string, DateTimeOffset)
Initializes a new instance of the SecurityAlert class.
public SecurityAlert(Guid alertId, string alertType, SecurityEventSeverity severity, string title, string description, DateTimeOffset detectedAt)
Parameters
alertIdGuidThe unique identifier for this security alert.
alertTypestringThe type of security alert.
severitySecurityEventSeverityThe severity level of the alert.
titlestringThe title or summary of the alert.
descriptionstringThe detailed description of the alert.
detectedAtDateTimeOffsetThe timestamp when the alert was detected.
Properties
AcknowledgedAt
Gets or initializes the timestamp when this alert was acknowledged.
public DateTimeOffset? AcknowledgedAt { get; init; }
Property Value
- DateTimeOffset?
The timestamp when this alert was acknowledged.
AcknowledgedBy
Gets or initializes the user who acknowledged this alert.
public string? AcknowledgedBy { get; init; }
Property Value
- string
The user who acknowledged this alert.
AlertId
Gets or initializes the unique identifier for this security alert.
public Guid AlertId { get; init; }
Property Value
- Guid
The unique identifier for this security alert.
AlertType
Gets or initializes the type of security alert.
public string AlertType { get; init; }
Property Value
- string
The type of security alert.
Context
Gets or initializes additional contextual information about the alert.
public IReadOnlyDictionary<string, object> Context { get; init; }
Property Value
- IReadOnlyDictionary<string, object>
Additional contextual information about the alert.
Description
Gets or initializes the detailed description of the alert.
public string Description { get; init; }
Property Value
- string
The detailed description of the alert.
DetectedAt
Gets or initializes the timestamp when the alert was detected.
public DateTimeOffset DetectedAt { get; init; }
Property Value
- DateTimeOffset
The timestamp when the alert was detected.
IsAcknowledged
Gets or initializes a value indicating whether this alert has been acknowledged.
public bool IsAcknowledged { get; init; }
Property Value
- bool
A value indicating whether this alert has been acknowledged.
IsResolved
Gets or initializes a value indicating whether this alert has been resolved.
public bool IsResolved { get; init; }
Property Value
- bool
A value indicating whether this alert has been resolved.
RecommendedActions
Gets or initializes the recommended actions for this alert.
public IReadOnlyList<string> RecommendedActions { get; init; }
Property Value
- IReadOnlyList<string>
The recommended actions for this alert.
RelatedAlerts
Gets or initializes related alert identifiers.
public IReadOnlyList<string> RelatedAlerts { get; init; }
Property Value
- IReadOnlyList<string>
Related alert identifiers.
ResolvedAt
Gets or initializes the timestamp when this alert was resolved.
public DateTimeOffset? ResolvedAt { get; init; }
Property Value
- DateTimeOffset?
The timestamp when this alert was resolved.
ResolvedBy
Gets or initializes the user who resolved this alert.
public string? ResolvedBy { get; init; }
Property Value
- string
The user who resolved this alert.
Severity
Gets or initializes the severity level of the alert.
public SecurityEventSeverity Severity { get; init; }
Property Value
- SecurityEventSeverity
The severity level of the alert.
Source
Gets or initializes the source entity or IP address that triggered this alert.
public string? Source { get; init; }
Property Value
- string
The source entity or IP address that triggered this alert.
Timestamp
Gets or initializes the timestamp when the alert was detected (alias for DetectedAt).
public DateTimeOffset Timestamp { get; init; }
Property Value
- DateTimeOffset
The timestamp when the alert was detected.
Title
Gets or initializes the title or summary of the alert.
public string Title { get; init; }
Property Value
- string
The title or summary of the alert.
UserId
Gets or initializes the user identifier associated with this alert.
public string? UserId { get; init; }
Property Value
- string
The user identifier associated with this alert.