Enum ContextDefinition 

#[non_exhaustive]
pub enum ContextDefinition {
    CedarJson(String),
    ContextMap(HashMap<String, AttributeValue>),
    #[non_exhaustive]
    Unknown,
}

Contains additional details about the context of the request. Verified Permissions evaluates this information in an authorization request as part of the when and unless clauses in a policy.

This data type is used as a request parameter for the IsAuthorized, BatchIsAuthorized, and IsAuthorizedWithToken operations.

If you're passing context as part of the request, exactly one instance of context must be passed. If you don't want to pass context, omit the context parameter from your request rather than sending context {}.

Example: "context":{"contextMap":{"<KeyName1>":{"boolean":true},"<KeyName2>":{"long":1234}}}

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

CedarJson(String)

A Cedar JSON string representation of the context needed to successfully evaluate an authorization request.

Example: {"cedarJson":"{\"<KeyName1>\": true, \"<KeyName2>\": 1234}" }

ContextMap(HashMap<String, AttributeValue>)

An list of attributes that are needed to successfully evaluate an authorization request. Each attribute in this array must include a map of a data type and its value.

Example: "contextMap":{"<KeyName1>":{"boolean":true},"<KeyName2>":{"long":1234}}

#[non_exhaustive]

Unknown

The Unknown variant represents cases where new union variant was received. Consider upgrading the SDK to the latest available version. An unknown enum variant

Note: If you encounter this error, consider upgrading your SDK to the latest version. The Unknown variant represents cases where the server sent a value that wasn’t recognized by the client. This can happen when the server adds new functionality, but the client has not been updated. To investigate this, consider turning on debug logging to print the raw HTTP response.

Implementations

impl ContextDefinition

pub fn as_cedar_json(&self) -> Result<&String, &Self>

Tries to convert the enum instance into CedarJson, extracting the inner String. Returns Err(&Self) if it can’t be converted.

pub fn is_cedar_json(&self) -> bool

Returns true if this is a CedarJson.

pub fn as_context_map(&self) -> Result<&HashMap<String, AttributeValue>, &Self>

Tries to convert the enum instance into ContextMap, extracting the inner HashMap. Returns Err(&Self) if it can’t be converted.

pub fn is_context_map(&self) -> bool

Returns true if this is a ContextMap.

pub fn is_unknown(&self) -> bool

Returns true if the enum instance is the Unknown variant.

Trait Implementations

impl Clone for ContextDefinition

fn clone(&self) -> ContextDefinition

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ContextDefinition

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

Formats the value using the given formatter.

impl PartialEq for ContextDefinition

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl StructuralPartialEq for ContextDefinition