Scale Intelligence■ Docs
Docs / The model / GrantRef

GrantRef.

A grant as a caller sees it, after the three narrowings

Figure 1GrantRefspecified
GRANTREFvalue at none scopegrantidmodeenum:read only|propose|act|full au…permissions[Permission]whereScopethe data group the grant names, whose members are the only units the call may touch (test 2)data_grouptextoptionalthe limits left on the grant: its budget, its rate, the voices and the sending identities it names (test 5)limitsGrantLimitsoptionalwhen the grant ends; a call after it is not allowed (test 5)ends_attimeoptionalPERMISSIONthrough permissionsSCOPEthrough whereGRANTLIMITSthrough limits
GrantRef is a value at none scope. The drawing shows its fields and the objects that they point at.
kind
value
scope
none
key
none
store
none
family
people

Fields#

fieldtyperequirednote
grantidyes
modeone of read only | propose | act | full autonomyyes
permissionsPermissionyes
whereScopeyes
data_grouptextnothe data group the grant names, whose members are the only units the call may touch (test 2)
limitsGrantLimitsnothe limits left on the grant: its budget, its rate, the voices and the sending identities it names (test 5)
ends_attimenowhen the grant ends; a call after it is not allowed (test 5)

Routes that use it#

No route takes or returns GrantRef directly. The record holds it, and the objects that point at it reach it.