Reference

Glossary

The words Access uses: principal, claim, grant, deny, governed field, namespace, guardrail, beacon and more.

Read as Markdown
TermMeaning
AccessThe policy engine and its tools. Authorization only.
PrincipalThe signed-in user as the rules see them (me), or null for an anonymous caller. You type it with .principal<P>().
IdentityWhat a verified token carries: { sub, claims }. AccessIdentity<typeof claims> is its type.
ClaimA value in the token beside sub, declared in policies.claims: { role: "string", banned: "boolean" }. Read from the user's field of the same name.
RoleA name for who may do something. Global (read from claims) or held on a row (on a Resource, with a where).
SubjectWho a grant is for: a role name, signedIn, or anyone.
GrantA rule that allows actions on Resources, optionally for some rows (where) and fields (fields).
DenyA rule that refuses. A matching deny wins over every grant.
OriginWhere a request comes from: client (a user's request), application (your server's own), or agent (an AI agent through the framework's MCP endpoint).
Governed fieldA field only a grant that names it opens. Its mode says for what: "both" (the list form: out of every default projection and written by no grant that does not name it), "write" (read as any field, written only by a naming grant) or "read" (written as any field, read only through a naming grant).
ScopeThe rows a principal may read, update or delete: true, false, or an Aventara where.
Policies fileThe rules compiled to passive JSON, format aventara-access/policies@1.
EngineThe thing that answers can, scopeOf, fieldsOf and grantsOf from a policies file.
ProfileHow the instance treats sessions: web, service or kiosk.
NamespaceOne service's name in the registry. It owns the rules for its own Resources.
RegistryThe part of Access that stores each namespace's policies file and the org's guardrails.
Push key, pull keyA namespace's keys: push may push and read, pull only reads.
LockavAccess.lock.json: the hashes of the pulled files.
GuardrailAn org-wide, deny-only rule every namespace's engine adds.
Foreign ResourceA Resource another namespace owns. Rules may read it in conditions but not grant, deny or govern on it.
BeaconA random value one service writes to its own database to prove other services share that database.
KioskA shared device that staff switch on by PIN.
BridgeThe organization bridge: it puts a member's role and organization into token claims.
HubAn app that runs Better Auth and is also the registry other services push to.
AventaraThe framework Access decides for.