Module

`security.audit`

Security audit events.

Small opt-in event channel for authentication and authorization telemetry. Applications can register a sink to forward events to logs, metrics, or SIEM.

Classes

SecurityEvent 6 ▼

A structured security event.

Attributes

Name	Type	Description
`name`	`str`	—
`timestamp`	`float`	—
`path`	`str \| None`	—
`method`	`str \| None`	—
`user_id`	`str \| None`	—
`details`	`dict[str, Any]`	—

Functions

set_security_event_sink 1 None ▼

Set a process-wide sink for security events. Pass ``None`` to disable event de…

def set_security_event_sink(sink: SecurityEventSink | None) -> None

Set a process-wide sink for security events.

PassNoneto disable event delivery.

Parameters

Name	Type	Description
`sink`	`SecurityEventSink \| None`

emit_security_event 4 None ▼

Emit a best-effort security event to the configured sink.

def emit_security_event(name: str, *, request: Any | None = None, user_id: str | None = None, details: dict[str, Any] | None = None) -> None

Parameters

Name	Type	Description
`name`	`str`
`request`	`Any \| None`	Default:`None`
`user_id`	`str \| None`	Default:`None`
`details`	`dict[str, Any] \| None`	Default:`None`