Skip to main content

ShieldResponse

Struct ShieldResponse 

Source
pub struct ShieldResponse {
Show 19 fields pub decision: String, pub actual_decision: Option<String>, pub mode_overridden: Option<bool>, pub effective_mode: Option<String>, pub alerted: Option<bool>, pub reason: Option<String>, pub audit_id: Option<String>, pub request_id: Option<String>, pub timestamp: String, pub determining_policies: Vec<DeterminingPolicy>, pub detectors: Vec<DetectorResult>, pub context: HashMap<String, Value>, pub projected_context: HashMap<String, Value>, pub latency_ms: Option<i64>, pub eval_latency_ms: Option<i64>, pub tiers_evaluated: Vec<String>, pub tiers_skipped: Vec<String>, pub session_delta: Option<SessionDelta>, pub root_causes: Vec<RootCause>,
}
Expand description

Response from POST /v1/guard.

Fields§

§decision: String

Enforced decision: "allow" or "deny".

§actual_decision: Option<String>

What Cedar would have decided before any mode override.

§mode_overridden: Option<bool>

true when a mode override changed the enforced decision.

§effective_mode: Option<String>

The effective policy mode that was applied.

§alerted: Option<bool>

true when an alert-mode policy fired (action allowed but flagged).

§reason: Option<String>

Human-readable reason for the decision (deny path).

§audit_id: Option<String>

Audit trail reference.

§request_id: Option<String>

Request correlation ID.

§timestamp: String

ISO 8601 response timestamp.

§determining_policies: Vec<DeterminingPolicy>

Policies that drove a deny decision.

§detectors: Vec<DetectorResult>

Per-detector results.

§context: HashMap<String, Value>

Merged raw detector context.

§projected_context: HashMap<String, Value>

Schema-normalised context sent to Cedar.

§latency_ms: Option<i64>

Total request latency in milliseconds.

§eval_latency_ms: Option<i64>

Cedar evaluation latency in milliseconds.

§tiers_evaluated: Vec<String>

Tiers that ran.

§tiers_skipped: Vec<String>

Tiers skipped due to early exit.

§session_delta: Option<SessionDelta>

Session state delta for this turn.

§root_causes: Vec<RootCause>

Root causes for a deny decision.

Implementations§

Source§

impl ShieldResponse

Source

pub fn allowed(&self) -> bool

Returns true when the decision is "allow".

Source

pub fn denied(&self) -> bool

Returns true when the decision is "deny".

Trait Implementations§

Source§

impl Clone for ShieldResponse

Source§

fn clone(&self) -> ShieldResponse

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 ShieldResponse

Source§

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

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

impl<'de> Deserialize<'de> for ShieldResponse

Source§

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

Deserialize this value from the given Serde deserializer. Read more

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> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
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> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

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