BBramaDocs
Browse documentation

Brama CLI command reference

brama subscription disown

Give one pool member back. The gateway retires it, forgets its stored credential and stops routing to it; any machine that signed that account in keeps its own session.

This command exists because the pool once accepted a grant that a coding harness on another machine already held. A provider issues one OAuth pair per sign-in and revokes it when a second holder refreshes, so such a member cost the machine it came from its own session. Taking a grant from a harness is no part of this product; giving one back is this command, and a gateway that needs a credential signs itself in with login (--by weles or --by hand).

Invocation

brama subscription disown --subscription-id <ID> --reason <REASON> [--gateway <ORIGIN> | --gateway-consumer <NAME>] [--bearer-role <ROLE>] [--json]
InputRequired/defaultMeaning
--subscription-id <ID>requiredThe pool member to give back.
--reason <REASON>requiredNonempty audit reason, recorded beside the gateway’s own ledger entry.
--gateway <ORIGIN>optionalThe gateway holding the member; its console bearer is read from stdin.
--gateway-consumer <NAME>optionalResolve that gateway through Stado’s service directory as this consumer, instead of naming a port the resolver assigns.
--bearer-role <ROLE>optionalRead the console bearer from the token field of the vault item that plays this role instead of stdin, so no secret is typed or written to disk and no item is named.
--jsonoptional; offPrint {"subscription_id", "detail"} instead of the line.

Output and state

On success one line names the retired member, or with --json one document carrying the member and the same sentence as detail. On the gateway the member is journaled as retired, the ledger records the reason, and the credential is removed from the vault item the pool wrote. Routing stops offering it at the next discovery.

Refusals

An empty id is refused with name the subscription to disown, an empty reason with --reason must say why this member is given back, and a call naming no gateway with name the gateway holding the member. The route requires the brama-desktop console identity; a pool holding no such member answers HTTP 404 with the pool holds no member with that id.

See the command group or the CLI tree.