Struct SessionEvent 

#[non_exhaustive]
pub struct SessionEvent {
    pub session_id: Uuid,
    pub subject: String,
    pub kind: EventKind,
    pub enforced: bool,
    pub score: Option<u32>,
    pub signals: Vec<Check>,
    pub ip: IpAddr,
    pub user_agent: Option<String>,
    pub client: ClientSummary,
    pub at: DateTime<Utc>,
}

One security event.

The subject is kept in its stored form (canonical JSON, see Subject); use subject to get it back as your type.

The on_event hook gets every client detail, for alerts. The copy written to the store leaves out the precise ones unless minimize_stored_events is turned off.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

session_id: Uuid

The session concerned.

subject: String

The session’s subject, as stored.

kind: EventKind

What happened.

enforced: bool

false when the decision was only recorded (shadow mode, or StepUpPolicy::Allow).

score: Option<u32>

Risk score, for risk decisions.

signals: Vec<Check>

Signals that fired, for risk decisions.

ip: IpAddr

Client IP. The stored copy keeps only its /24 or /48 network address by default.

user_agent: Option<String>

Client User-Agent, truncated to the header cap. Not stored by default.

client: ClientSummary

Where the request came from and what sent it. The stored copy leaves out the city by default.

at: DateTime<Utc>

When it happened.

Implementations

impl SessionEvent

pub fn subject<S: Subject>(&self) -> Option<S>

The subject as S, or None if the stored value does not parse as S.

Trait Implementations

impl Clone for SessionEvent

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for SessionEvent

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Eq for SessionEvent

impl PartialEq for SessionEvent

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for SessionEvent