AlmondTill/G3N API

Principal

object type

A resolved session principal — what an authenticated call acts as.

Fields

FieldTypeNotes
sessionIdID ID!No further notes.
kindString String!The principal class — user | api | device.
userIdIDThe User construct the session is a principal of — user kind only (null on api/device).
accountIdIDThe acting Account — user + api kinds (the api kind's = the MINTER's Account); null on device.
apiKeyIdIDThe ApiKey the session was exchanged from — api kind only.
deviceIdIDThe Device the session belongs to — the device kind, AND the user kind on a COMPOSITE POS session (the x-at-device-session facet); null otherwise.
deviceTypeStringThe device's canned hardware class — the device kind + the composite POS session's user kind; null otherwise.
registerIdIDThe device's LIVE 0..1 Register binding — the device kind + the composite POS session's user kind (null while unpaired / on pi_bridge / without a device facet). The register derives its till + selling location from THIS, never from a device(id) read (a cashier tier cannot make one).
logicalFacilityIdIDThe device's parent LogicalFacility (the selling location) — the device kind + the composite POS session's user kind; null otherwise.
orgIdID ID!The organization the session acts in (the attribution org).
rootIdID ID!The org-group family root.
capabilityStringThe LIVE effective capability, re-derived from the account status every call — user/api kinds; null on device (a device carries trust, never authority — E).
groupCaptionStringThe session’s organization GROUP caption; read from the group record on every me — null only when the session names no group (never for a live session).
roleCaptionsString [String!]The captions of the roles the session ACTS with in its organization — user kind only; null on the api/device kinds (their authority is the key’s / the device’s, not a role’s).

Used by