Struct Request

pub struct Request(/* private fields */);

An authorization request is a tuple <P, A, R, C> where

• P is the principal EntityUid,
• A is the action EntityUid,
• R is the resource EntityUid, and
• C is the request Context record.

It represents an authorization request asking the question, “Can this principal take this action on this resource in this context?”

Implementations

impl Request

pub fn builder() -> RequestBuilder<UnsetSchema>

Available on crate feature partial-eval only.

Create a RequestBuilder

This feature is experimental. For more information see https://github.com/cedar-policy/rfcs/blob/main/README.md#experimental-features

pub fn new( principal: EntityUid, action: EntityUid, resource: EntityUid, context: Context, schema: Option<&Schema>, ) -> Result<Self, RequestValidationError>

Create a Request.

Note that you can create the EntityUids using .parse() on any string (via the FromStr implementation for EntityUid). The principal, action, and resource fields are optional to support the case where these fields do not contribute to authorization decisions (e.g., because they are not used in your policies). If any of the fields are None, we will automatically generate a unique entity UID that is not equal to any UID in the store.

If schema is present, this constructor will validate that the Request complies with the given schema.

pub fn context(&self) -> Option<&Context>

Get the context component of the request. Returns None if the context is “unknown” (i.e., constructed using the partial evaluation APIs).

pub fn principal(&self) -> Option<&EntityUid>

Get the principal component of the request. Returns None if the principal is “unknown” (i.e., constructed using the partial evaluation APIs).

pub fn action(&self) -> Option<&EntityUid>

Get the action component of the request. Returns None if the action is “unknown” (i.e., constructed using the partial evaluation APIs).

pub fn resource(&self) -> Option<&EntityUid>

Get the resource component of the request. Returns None if the resource is “unknown” (i.e., constructed using the partial evaluation APIs).

Trait Implementations

impl Clone for Request

fn clone(&self) -> Request

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Request

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

Formats the value using the given formatter.

impl Display for Request

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

Formats the value using the given formatter.

impl RefCast for Request

type From = Request

fn ref_cast(_from: &Self::From) -> &Self

fn ref_cast_mut(_from: &mut Self::From) -> &mut Self