ApiSessionInterfaces
Interface: Grant
Defined in: packages/core/src/session/connect.ts:152
What the home hands back when the person approves
Properties
| Property | Modifier | Type | Description | Defined in |
|---|---|---|---|---|
access | readonly | "read" | "write" | - | packages/core/src/session/connect.ts:160 |
accountKey? | readonly | string | With 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? | readonly | string | With 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? | readonly | string | With contacts: which of spaces is the account's contacts space | packages/core/src/session/connect.ts:177 |
did | readonly | string | The account's identity — what the app acts for | packages/core/src/session/connect.ts:155 |
expiresAt | readonly | number | Unix seconds | packages/core/src/session/connect.ts:179 |
home | readonly | string | The home that granted it, so the app can go back there | packages/core/src/session/connect.ts:181 |
name | readonly | string | The account's name, for showing who is connected | packages/core/src/session/connect.ts:157 |
note | readonly | Delegation | The signed note: the account → the app's key, for these spaces, until expiresAt | packages/core/src/session/connect.ts:159 |
relays? | readonly | readonly 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 |
scope | readonly | "spaces" | "account" | - | packages/core/src/session/connect.ts:161 |
spaces | readonly | readonly GrantedSpace[] | - | packages/core/src/session/connect.ts:162 |
v | readonly | 2 | - | packages/core/src/session/connect.ts:153 |