Skip to main content

Module request

Module request 

Source
Expand description

One request to judge, and how it becomes Cedar’s principal, action, resource, context and entity store.

Structs§

AccountAttributes
What the gate knows about the account beyond its DID. Each is absent when the gate does not carry it, and a statement guards it with has.
Built 🔒
Prepared 🔒
A request ready for any number of statements to judge.
Request
One request for a document to judge.
RequestError
The request could not be turned into something Cedar can judge. The caller refuses: nothing was evaluated, so nothing was permitted.

Enums§

Action
The action being asked about, with its resource and context.
Operation
What a record.write does to the record.
Principal
Who is asking, as much of it as the gate knows.

Functions§

client_entity 🔒
The Client entity a write’s context.client refers to, with the same id attribute the OAuth actions’ resource carries.
datetime 🔒
A Cedar datetime value in the JSON form the context parser reads.
entity_ref 🔒
typed 🔒
A record as Cedar sees it: the fields the shape types as datetime become datetime values, everything else passes through as JSON. With no shape, everything passes through.
typed_field 🔒