UserQuery

Struct UserQuery 

Source
#[non_exhaustive]
pub struct UserQuery {
Show 58 fields pub action: Option<String>, pub action_id: Option<i64>, pub activity_id: Option<i64>, pub activity_name: Option<String>, pub actor: Option<Box<Actor>>, pub api: Option<Box<Api>>, pub attacks: Option<Vec<Attack>>, pub authorizations: Option<Vec<Authorization>>, pub category_name: Option<String>, pub category_uid: Option<i64>, pub class_name: Option<String>, pub class_uid: Option<i64>, pub cloud: Option<Box<Cloud>>, pub confidence: Option<String>, pub confidence_id: Option<i64>, pub confidence_score: Option<i64>, pub count: Option<i64>, pub device: Option<Box<Device>>, pub disposition: Option<String>, pub disposition_id: Option<i64>, pub duration: Option<i64>, pub end_time: Option<i64>, pub end_time_dt: Option<String>, pub enrichments: Option<Vec<Enrichment>>, pub firewall_rule: Option<Box<FirewallRule>>, pub is_alert: Option<bool>, pub malware: Option<Vec<Malware>>, pub malware_scan_info: Option<Box<MalwareScanInfo>>, pub message: Option<String>, pub metadata: Option<Box<Metadata>>, pub observables: Option<Vec<Observable>>, pub osint: Option<Vec<Osint>>, pub policy: Option<Box<Policy>>, pub query_info: Option<Box<QueryInfo>>, pub query_result: Option<String>, pub query_result_id: Option<i64>, pub raw_data: Option<String>, pub raw_data_hash: Option<Box<Fingerprint>>, pub raw_data_size: Option<i64>, pub risk_details: Option<String>, pub risk_level: Option<String>, pub risk_level_id: Option<i64>, pub risk_score: Option<i64>, pub severity: Option<String>, pub severity_id: Option<i64>, pub start_time: Option<i64>, pub start_time_dt: Option<String>, pub status: Option<String>, pub status_code: Option<String>, pub status_detail: Option<String>, pub status_id: Option<i64>, pub time: Option<i64>, pub time_dt: Option<String>, pub timezone_offset: Option<i64>, pub type_name: Option<String>, pub type_uid: Option<i64>, pub unmapped: Option<Value>, pub user: Option<Box<User>>,
}
👎Deprecated: Use the <code>Live Evidence Info</code> class. (Since 1.5.0)
Expand description

User Query

User Query events report user data that have been discovered, queried, polled or searched. This event differs from User Inventory as it describes the result of a targeted search by filtering a subset of user attributes.

[UID:5018] Category: discovery | Name: user_query

Fields (Non-exhaustive)§

This struct is marked as 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.
§action: Option<String>
👎Deprecated: Use the <code>Live Evidence Info</code> class. (Since 1.5.0)

Action

The normalized caption of action_id.

optional

§action_id: Option<i64>
👎Deprecated: Use the <code>Live Evidence Info</code> class. (Since 1.5.0)

Action ID

The action taken by a control or other policy-based system leading to an outcome or disposition. An unknown action may still correspond to a known disposition. Refer to disposition_id for the outcome of the action.

recommended

§activity_id: Option<i64>
👎Deprecated: Use the <code>Live Evidence Info</code> class. (Since 1.5.0)

Activity ID

The normalized identifier of the activity that triggered the event.

required

§activity_name: Option<String>
👎Deprecated: Use the <code>Live Evidence Info</code> class. (Since 1.5.0)

Activity

The event activity name, as defined by the activity_id.

optional

§actor: Option<Box<Actor>>
👎Deprecated: Use the <code>Live Evidence Info</code> class. (Since 1.5.0)

Actor

The actor object describes details about the user/role/process that was the source of the activity. Note that this is not the threat actor of a campaign but may be part of a campaign.

optional

§api: Option<Box<Api>>
👎Deprecated: Use the <code>Live Evidence Info</code> class. (Since 1.5.0)

API Details

Describes details about a typical API (Application Programming Interface) call.

optional

§attacks: Option<Vec<Attack>>
👎Deprecated: Use the <code>Live Evidence Info</code> class. (Since 1.5.0)

MITRE ATT&CK® and ATLAS™ Details

An array of MITRE ATT&CK® objects describing identified tactics, techniques & sub-techniques. The objects are compatible with MITRE ATLAS™ tactics, techniques & sub-techniques.

optional

§authorizations: Option<Vec<Authorization>>
👎Deprecated: Use the <code>Live Evidence Info</code> class. (Since 1.5.0)

Authorization Information

Provides details about an authorization, such as authorization outcome, and any associated policies related to the activity/event.

optional

§category_name: Option<String>
👎Deprecated: Use the <code>Live Evidence Info</code> class. (Since 1.5.0)

Category

The event category name, as defined by category_uid value: Discovery.

optional

§category_uid: Option<i64>
👎Deprecated: Use the <code>Live Evidence Info</code> class. (Since 1.5.0)

Category ID

The category unique identifier of the event.

required

§class_name: Option<String>
👎Deprecated: Use the <code>Live Evidence Info</code> class. (Since 1.5.0)

Class

The event class name, as defined by class_uid value: User Query.

optional

§class_uid: Option<i64>
👎Deprecated: Use the <code>Live Evidence Info</code> class. (Since 1.5.0)

Class ID

The unique identifier of a class. A class describes the attributes available in an event.

required

§cloud: Option<Box<Cloud>>
👎Deprecated: Use the <code>Live Evidence Info</code> class. (Since 1.5.0)

Cloud

Describes details about the Cloud environment where the event or finding was created.

required

§confidence: Option<String>
👎Deprecated: Use the <code>Live Evidence Info</code> class. (Since 1.5.0)

Confidence

The confidence, normalized to the caption of the confidence_id value. In the case of ‘Other’, it is defined by the event source.

optional

§confidence_id: Option<i64>
👎Deprecated: Use the <code>Live Evidence Info</code> class. (Since 1.5.0)

Confidence ID

The normalized confidence refers to the accuracy of the rule that created the finding. A rule with a low confidence means that the finding scope is wide and may create finding reports that may not be malicious in nature.

recommended

§confidence_score: Option<i64>
👎Deprecated: Use the <code>Live Evidence Info</code> class. (Since 1.5.0)

Confidence Score

The confidence score as reported by the event source.

optional

§count: Option<i64>
👎Deprecated: Use the <code>Live Evidence Info</code> class. (Since 1.5.0)

Count

The number of times that events in the same logical group occurred during the event Start Time to End Time period.

optional

§device: Option<Box<Device>>
👎Deprecated: Use the <code>Live Evidence Info</code> class. (Since 1.5.0)

Device

An addressable device, computer system or host.

recommended

§disposition: Option<String>
👎Deprecated: Use the <code>Live Evidence Info</code> class. (Since 1.5.0)

Disposition

The disposition name, normalized to the caption of the disposition_id value. In the case of ‘Other’, it is defined by the event source.

optional

§disposition_id: Option<i64>
👎Deprecated: Use the <code>Live Evidence Info</code> class. (Since 1.5.0)

Disposition ID

Describes the outcome or action taken by a security control, such as access control checks, malware detections or various types of policy violations.

recommended

§duration: Option<i64>
👎Deprecated: Use the <code>Live Evidence Info</code> class. (Since 1.5.0)

Duration Milliseconds

The event duration or aggregate time, the amount of time the event covers from start_time to end_time in milliseconds.

optional

§end_time: Option<i64>
👎Deprecated: Use the <code>Live Evidence Info</code> class. (Since 1.5.0)

End Time

The end time of a time period, or the time of the most recent event included in the aggregate event.

optional

§end_time_dt: Option<String>
👎Deprecated: Use the <code>Live Evidence Info</code> class. (Since 1.5.0)

End Time

The end time of a time period, or the time of the most recent event included in the aggregate event.

optional

§enrichments: Option<Vec<Enrichment>>
👎Deprecated: Use the <code>Live Evidence Info</code> class. (Since 1.5.0)

Enrichments

The additional information from an external data source, which is associated with the event or a finding. For example add location information for the IP address in the DNS answers:

[{“name”: “answers.ip”, “value”: “92.24.47.250”, “type”: “location”, “data”: {“city”: “Socotra”, “continent”: “Asia”, “coordinates”: [-25.4153, 17.0743], “country”: “YE”, “desc”: “Yemen”}}]

optional

§firewall_rule: Option<Box<FirewallRule>>
👎Deprecated: Use the <code>Live Evidence Info</code> class. (Since 1.5.0)

Firewall Rule

The firewall rule that pertains to the control that triggered the event, if applicable.

optional

§is_alert: Option<bool>
👎Deprecated: Use the <code>Live Evidence Info</code> class. (Since 1.5.0)

Alert

Indicates that the event is considered to be an alertable signal. Should be set to true if disposition_id = Alert among other dispositions, and/or risk_level_id or severity_id of the event is elevated. Not all control events will be alertable, for example if disposition_id = Exonerated or disposition_id = Allowed.

recommended

§malware: Option<Vec<Malware>>
👎Deprecated: Use the <code>Live Evidence Info</code> class. (Since 1.5.0)

Malware

A list of Malware objects, describing details about the identified malware.

optional

§malware_scan_info: Option<Box<MalwareScanInfo>>
👎Deprecated: Use the <code>Live Evidence Info</code> class. (Since 1.5.0)

Malware Scan Info

Describes details about the scan job that identified malware on the target system.

optional

§message: Option<String>
👎Deprecated: Use the <code>Live Evidence Info</code> class. (Since 1.5.0)

Message

The description of the event/finding, as defined by the source.

recommended

§metadata: Option<Box<Metadata>>
👎Deprecated: Use the <code>Live Evidence Info</code> class. (Since 1.5.0)

Metadata

The metadata associated with the event or a finding.

required

§observables: Option<Vec<Observable>>
👎Deprecated: Use the <code>Live Evidence Info</code> class. (Since 1.5.0)

Observables

The observables associated with the event or a finding.

recommended

§osint: Option<Vec<Osint>>
👎Deprecated: Use the <code>Live Evidence Info</code> class. (Since 1.5.0)

OSINT

The OSINT (Open Source Intelligence) object contains details related to an indicator such as the indicator itself, related indicators, geolocation, registrar information, subdomains, analyst commentary, and other contextual information. This information can be used to further enrich a detection or finding by providing decisioning support to other analysts and engineers.

required

§policy: Option<Box<Policy>>
👎Deprecated: Use the <code>Live Evidence Info</code> class. (Since 1.5.0)

Policy

The policy that pertains to the control that triggered the event, if applicable. For example the name of an anti-malware policy or an access control policy.

optional

§query_info: Option<Box<QueryInfo>>
👎Deprecated: Use the <code>Live Evidence Info</code> class. (Since 1.5.0)

Query Info

The search details associated with the query request.

recommended

§query_result: Option<String>
👎Deprecated: Use the <code>Live Evidence Info</code> class. (Since 1.5.0)

Query Result

The result of the query.

recommended

§query_result_id: Option<i64>
👎Deprecated: Use the <code>Live Evidence Info</code> class. (Since 1.5.0)

Query Result ID

The normalized identifier of the query result.

required

§raw_data: Option<String>
👎Deprecated: Use the <code>Live Evidence Info</code> class. (Since 1.5.0)

Raw Data

The raw event/finding data as received from the source.

optional

§raw_data_hash: Option<Box<Fingerprint>>
👎Deprecated: Use the <code>Live Evidence Info</code> class. (Since 1.5.0)

Raw Data Hash

The hash, which describes the content of the raw_data field.

optional

§raw_data_size: Option<i64>
👎Deprecated: Use the <code>Live Evidence Info</code> class. (Since 1.5.0)

Raw Data Size

The size of the raw data which was transformed into an OCSF event, in bytes.

optional

§risk_details: Option<String>
👎Deprecated: Use the <code>Live Evidence Info</code> class. (Since 1.5.0)

Risk Details

Describes the risk associated with the finding.

optional

§risk_level: Option<String>
👎Deprecated: Use the <code>Live Evidence Info</code> class. (Since 1.5.0)

Risk Level

The risk level, normalized to the caption of the risk_level_id value.

optional

§risk_level_id: Option<i64>
👎Deprecated: Use the <code>Live Evidence Info</code> class. (Since 1.5.0)

Risk Level ID

The normalized risk level id.

optional

§risk_score: Option<i64>
👎Deprecated: Use the <code>Live Evidence Info</code> class. (Since 1.5.0)

Risk Score

The risk score as reported by the event source.

optional

§severity: Option<String>
👎Deprecated: Use the <code>Live Evidence Info</code> class. (Since 1.5.0)

Severity

The event/finding severity, normalized to the caption of the severity_id value. In the case of ‘Other’, it is defined by the source.

optional

§severity_id: Option<i64>
👎Deprecated: Use the <code>Live Evidence Info</code> class. (Since 1.5.0)

Severity ID

The normalized identifier of the event/finding severity.

The normalized severity is a measurement the effort and expense required to manage and resolve an event or incident. Smaller numerical values represent lower impact events, and larger numerical values represent higher impact events.

required

§start_time: Option<i64>
👎Deprecated: Use the <code>Live Evidence Info</code> class. (Since 1.5.0)

Start Time

The start time of a time period, or the time of the least recent event included in the aggregate event.

optional

§start_time_dt: Option<String>
👎Deprecated: Use the <code>Live Evidence Info</code> class. (Since 1.5.0)

Start Time

The start time of a time period, or the time of the least recent event included in the aggregate event.

optional

§status: Option<String>
👎Deprecated: Use the <code>Live Evidence Info</code> class. (Since 1.5.0)

Status

The event status, normalized to the caption of the status_id value. In the case of ‘Other’, it is defined by the event source.

recommended

§status_code: Option<String>
👎Deprecated: Use the <code>Live Evidence Info</code> class. (Since 1.5.0)

Status Code

The event status code, as reported by the event source.

For example, in a Windows Failed Authentication event, this would be the value of ‘Failure Code’, e.g. 0x18.

recommended

§status_detail: Option<String>
👎Deprecated: Use the <code>Live Evidence Info</code> class. (Since 1.5.0)

Status Detail

The status detail contains additional information about the event/finding outcome.

recommended

§status_id: Option<i64>
👎Deprecated: Use the <code>Live Evidence Info</code> class. (Since 1.5.0)

Status ID

The normalized identifier of the event status.

recommended

§time: Option<i64>
👎Deprecated: Use the <code>Live Evidence Info</code> class. (Since 1.5.0)

Event Time

The normalized event occurrence time or the finding creation time.

required

§time_dt: Option<String>
👎Deprecated: Use the <code>Live Evidence Info</code> class. (Since 1.5.0)

Event Time

The normalized event occurrence time or the finding creation time.

optional

§timezone_offset: Option<i64>
👎Deprecated: Use the <code>Live Evidence Info</code> class. (Since 1.5.0)

Timezone Offset

The number of minutes that the reported event time is ahead or behind UTC, in the range -1,080 to +1,080.

recommended

§type_name: Option<String>
👎Deprecated: Use the <code>Live Evidence Info</code> class. (Since 1.5.0)

Type Name

The event/finding type name, as defined by the type_uid.

optional

§type_uid: Option<i64>
👎Deprecated: Use the <code>Live Evidence Info</code> class. (Since 1.5.0)

Type ID

The event/finding type ID. It identifies the event’s semantics and structure. The value is calculated by the logging system as: class_uid * 100 + activity_id.

required

§unmapped: Option<Value>
👎Deprecated: Use the <code>Live Evidence Info</code> class. (Since 1.5.0)

Unmapped Data

The attributes that are not mapped to the event schema. The names and values of those attributes are specific to the event source.

optional

§user: Option<Box<User>>
👎Deprecated: Use the <code>Live Evidence Info</code> class. (Since 1.5.0)

User

The user that pertains to the event or object.

required

Trait Implementations§

Source§

impl Clone for UserQuery

Source§

fn clone(&self) -> UserQuery

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for UserQuery

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for UserQuery

Source§

fn default() -> UserQuery

Returns the “default value” for a type. Read more
Source§

impl<'de> Deserialize<'de> for UserQuery

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl PartialEq for UserQuery

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl Serialize for UserQuery

Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more
Source§

impl StructuralPartialEq for UserQuery

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,