Skip to content

Commit 8b1521d

Browse files
docs: Update documentation for controller PR #2396 (#197)
Updates documentation to reflect changes made in: Expose session GUID fields in keychain callback Related controller PR: cartridge-gg/controller#2396 Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
1 parent 45dd784 commit 8b1521d

File tree

1 file changed

+14
-0
lines changed

1 file changed

+14
-0
lines changed

src/pages/controller/native/session-flow.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -86,5 +86,19 @@ After successful session creation, the following metadata is available:
8686
| `appId` | string? | The application identifier |
8787
| `isRevoked` | boolean | Whether the session has been revoked |
8888

89+
### Additional Fields for Already-Registered Sessions
90+
91+
When a session is already registered and authorized, the callback payload includes additional session identifiers:
92+
93+
| Field | Type | Description |
94+
|-------|------|-------------|
95+
| `allowedPoliciesRoot` | string | Root hash of the allowed policies for this session |
96+
| `metadataHash` | string | Hash of the session metadata |
97+
| `sessionKeyGuid` | string | Unique identifier for the session key |
98+
| `guardianKeyGuid` | string | Unique identifier for the guardian key |
99+
| `alreadyRegistered` | boolean | Flag indicating this is an existing session |
100+
101+
These fields are only included when returning an existing authorized session (when `alreadyRegistered` is `true`). For new session registrations, only the basic metadata fields are returned.
102+
89103
Fields marked with `?` are only populated when creating sessions via the subscription API flow (`createFromSubscribe`).
90104
When creating sessions directly with the constructor, these fields will be `null`.

0 commit comments

Comments
 (0)