brama subscription forget¶
Drop one id the gateway's usage history remembers and its vault does not, for a reason the journal keeps in your words.
The pool is what the vault lists plus what discovery enrolled from the harnesses’ own account commands and from purchase receipts. The usage ledger remembers every id that ever ran through the gateway; one the vault no longer returns, and that was never retired, is no pool member: list does not list it among the members and nothing counts it — not a lease, not the sessions-per-subscription limit, not the purchase shortage. It is answered apart, under remembered ({id, provider}; the text output prints remembered by the usage history only, not pool members (N): … and each id), so a test or renamed id that once served a request does not stand beside the operator’s real accounts. disown refuses such an id with the pool holds no member with that id, because disowning retires a member the vault lists and removes its credential; this verb drops its ledger row.
Forgetting is membership, not a credential: nothing is read from or written to the vault. The gateway writes a forgotten record with the reason to its journal, drops any overlay entry and local credential left under the id, and removes the usage history row, so the next pool report no longer lists the member. A forgotten id is a tombstone, not a ban on the account: discovery may enrol the same account again under its own identity, as after a reconciliation removal.
Invocation¶
brama subscription forget --subscription-id <ID> --reason <REASON> [--gateway <ORIGIN> | --gateway-consumer <NAME>] [--bearer-role <ROLE>] [--json]| Input | Required/default | Meaning |
|---|---|---|
--subscription-id <ID> | required | The remembered member to drop. |
--reason <REASON> | required | Nonempty reason, journaled on the gateway in these words. |
--gateway <ORIGIN> | optional | The gateway holding the usage history; its console bearer is read from stdin. Named neither this nor --gateway-consumer, the command acts on this host’s own usage history through the same code the gateway’s route runs. |
--gateway-consumer <NAME> | optional | Resolve that gateway through Stado’s service directory as this consumer. |
--bearer-role <ROLE> | optional | Read the console bearer from the token field of the vault item that plays this role instead of stdin. |
--json | optional; off | Print {"subscription_id", "detail"} instead of the line. |
Output and state¶
One line names the member and what happened, or with --json one document with the member and that sentence as detail. The journal gains a {"kind": "forgotten", "id", "reason", "at"} record; the usage ledger loses the member’s row; brama subscription list no longer lists it and no longer reports exists in usage history for it.
$ brama subscription forget --subscription-id brama-sub-<member> --reason "this account was never signed in on this gateway"
brama-sub-<member>: the member existed only in the usage history and is forgotten: it leaves the pool report, the reason stands in the journal, and discovery may enrol the account again under its own identityIn Brama Desktop the same act is Forget beside each id in the pool screen’s Remembered by the usage history only panel, under the purchase panel, and Forget this member in the Membership section of a member that reads Retired; the field above the buttons is the reason, and they stay disabled until it says something.
Refusals¶
An empty id is refused with name the subscription to forget, an empty reason with --reason must say why this member is forgotten. A member the vault lists is refused with the vault lists <id> (<provider>) as a member of the pool, so it is not a memory: give it back with brama subscription disown; a member neither the vault nor the usage history knows with neither the vault nor the usage history knows <id>; there is nothing to forget; a member a live session still leases with still carries N live session lease(s) (<session ids>); release them first with brama subscription lease release. A vault, lease register or journal that cannot be read is refused with its own cause. Over HTTP those are 400, 409, 404, 409 and 503; the route requires the brama-desktop console identity.
See the command group or the CLI tree.