minca
ApiSessionInterfaces

Interface: Grant

Defined in: packages/core/src/session/connect.ts:152

What the home hands back when the person approves

Properties

PropertyModifierTypeDescriptionDefined in
accessreadonly"read" | "write"-packages/core/src/session/connect.ts:160
accountKey?readonlystringWith account scope: the key the account's space list is derived from (base64url), so the app sees every space and adds the ones it makes or joins. It opens every private space in the account — which is what whole account access means — but it cannot sign as the account.packages/core/src/session/connect.ts:169
contactKey?readonlystringWith contacts, or account scope: the contact key's private scalar (base64url), which opens contact requests sent to the account (deriveContactKeyBytes). It cannot sign as the account.packages/core/src/session/connect.ts:175
contactsSpace?readonlystringWith contacts: which of spaces is the account's contacts spacepackages/core/src/session/connect.ts:177
didreadonlystringThe account's identity — what the app acts forpackages/core/src/session/connect.ts:155
expiresAtreadonlynumberUnix secondspackages/core/src/session/connect.ts:179
homereadonlystringThe home that granted it, so the app can go back therepackages/core/src/session/connect.ts:181
namereadonlystringThe account's name, for showing who is connectedpackages/core/src/session/connect.ts:157
notereadonlyDelegationThe signed note: the account → the app's key, for these spaces, until expiresAtpackages/core/src/session/connect.ts:159
relays?readonlyreadonly string[]Relays the home meets peers on. A home someone runs themselves may use different ones from the app, and two peers that share no relay never meet — so the app joins these as well.packages/core/src/session/connect.ts:187
scopereadonly"spaces" | "account"-packages/core/src/session/connect.ts:161
spacesreadonlyreadonly GrantedSpace[]-packages/core/src/session/connect.ts:162
vreadonly2-packages/core/src/session/connect.ts:153

On this page