CLI: consumer
Complete help for farthershore consumer and every subcommand.
farthershore consumer
Usage: farthershore consumer [options] [command]
Manage business users/consumers
Options:
-h, --help display help for command
Commands:
list [options] [businessIdOrSlug] List users/consumers for a business
block [options] [businessIdOrSlug] [subscriberId] Block a user and revoke their active API keys
keys List and revoke ONE consumer's API keys. Listing is metadata only — key material is never returned. `consumer block` revokes every key at once; this is the surgical version
migrate-latest [options] [businessIdOrSlug] [subscriberId] Move one consumer to the active head of their plan lineage
remove [options] [businessIdOrSlug] [subscriberId] Remove a user from live business access
rbac Builder-plane Managed RBAC for one subscriber: the per-subscriber enforcement flag, its roles, and member role assignment. Enforcement also requires the product flag (`farthershore business rbac enable`)
help [command] display help for command
farthershore consumer list
Usage: farthershore consumer list [options] [businessIdOrSlug]
List users/consumers for a business
Options:
--env <env> Environment name for preview-scoped consumers.
-h, --help display help for command
farthershore consumer block
Usage: farthershore consumer block [options] [businessIdOrSlug] <subscriberId>
Block a user and revoke their active API keys
Options:
--yes Skip confirmation; required for this destructive action
-h, --help display help for command
farthershore consumer keys
Usage: farthershore consumer keys [options] [command]
List and revoke ONE consumer's API keys. Listing is metadata only — key material
is never returned. `consumer block` revokes every key at once; this is the
surgical version
Options:
-h, --help display help for command
Commands:
list [businessIdOrSlug] [subscriberId] List a consumer's API keys (metadata only)
revoke [options] [businessIdOrSlug] [subscriberId] [keyId] Revoke ONE of a consumer's API keys
help [command] display help for command
farthershore consumer keys list
Usage: farthershore consumer keys list [options] [businessIdOrSlug] <subscriberId>
List a consumer's API keys (metadata only)
Options:
-h, --help display help for command
farthershore consumer keys revoke
Usage: farthershore consumer keys revoke [options] [businessIdOrSlug] <subscriberId> <keyId>
Revoke ONE of a consumer's API keys
Options:
--yes Skip confirmation; required for this destructive action
-h, --help display help for command
farthershore consumer migrate-latest
Usage: farthershore consumer migrate-latest [options] [businessIdOrSlug] <subscriberId>
Move one consumer to the active head of their plan lineage
Options:
--idempotency-key <key> Required for this mutation. Generate it once and
reuse the exact value on retry.
-h, --help display help for command
farthershore consumer remove
Usage: farthershore consumer remove [options] [businessIdOrSlug] <subscriberId>
Remove a user from live business access
Options:
--yes Skip confirmation; required for this destructive action
-h, --help display help for command
farthershore consumer rbac
Usage: farthershore consumer rbac [options] [command]
Builder-plane Managed RBAC for one subscriber: the per-subscriber enforcement
flag, its roles, and member role assignment. Enforcement also requires the
product flag (`farthershore business rbac enable`)
Options:
-h, --help display help for command
Commands:
assign [options] [businessIdOrSlug] [subscriberId] [userExternalId] Replace a client-org member's Managed-RBAC business roles (builder support override)
enable [options] [businessIdOrSlug] [subscriberId] Turn Managed-RBAC enforcement on for one subscriber
disable [businessIdOrSlug] [subscriberId] Turn Managed-RBAC enforcement off for one subscriber
roles Create, read, update, and delete one subscriber's Managed-RBAC roles. The subscribing org manages the same rows from its portal (/settings/team)
help [command] display help for command
farthershore consumer rbac assign
Usage: farthershore consumer rbac assign [options] [businessIdOrSlug] <subscriberId> <userExternalId>
Replace a client-org member's Managed-RBAC business roles (builder support
override)
Options:
--roles <roles> Comma-separated business-role keys to set (replaces the
current assignment; pass an empty string to clear).
-h, --help display help for command
farthershore consumer rbac enable
Usage: farthershore consumer rbac enable [options] [businessIdOrSlug] <subscriberId>
Turn Managed-RBAC enforcement on for one subscriber
Options:
--default-role <roleKey> Role key new members fall back to when they have no
explicit role. Omit to clear it.
-h, --help display help for command
Enforcement needs BOTH flags: the product flag (`farthershore business rbac enable`) and this per-subscriber flag. With the product flag off, core answers 400 RBAC_NOT_ENABLED_BY_PRODUCT. The subscribing org can flip the same flag itself at the portal's /settings/team page.
farthershore consumer rbac disable
Usage: farthershore consumer rbac disable [options] [businessIdOrSlug] <subscriberId>
Turn Managed-RBAC enforcement off for one subscriber
Options:
-h, --help display help for command
Disabling is an ACCESS EXPANSION: with enforcement off, credential permission resolution can return ['*']. Role definitions are preserved for re-enable.
farthershore consumer rbac roles
Usage: farthershore consumer rbac roles [options] [command]
Create, read, update, and delete one subscriber's Managed-RBAC roles. The
subscribing org manages the same rows from its portal (/settings/team)
Options:
-h, --help display help for command
Commands:
list [businessIdOrSlug] [subscriberId] List one subscriber's Managed-RBAC roles
create [options] [businessIdOrSlug] [subscriberId] [roleKey] Create a CUSTOM Managed-RBAC role for one subscriber
update [options] [businessIdOrSlug] [subscriberId] [roleKey] Rename or re-permission one subscriber Managed-RBAC role
delete [options] [businessIdOrSlug] [subscriberId] [roleKey] Delete one subscriber Managed-RBAC role
help [command] display help for command
farthershore consumer rbac roles list
Usage: farthershore consumer rbac roles list [options] [businessIdOrSlug] <subscriberId>
List one subscriber's Managed-RBAC roles
Options:
-h, --help display help for command
farthershore consumer rbac roles create
Usage: farthershore consumer rbac roles create [options] [businessIdOrSlug] <subscriberId> <roleKey>
Create a CUSTOM Managed-RBAC role for one subscriber
Options:
--name <name> Human-readable role name.
--permissions <permissions> Comma-separated permission keys from the
business's derived catalog (e.g.
`reports:read,reports:write`).
-h, --help display help for command
farthershore consumer rbac roles update
Usage: farthershore consumer rbac roles update [options] [businessIdOrSlug] <subscriberId> <roleKey>
Rename or re-permission one subscriber Managed-RBAC role
Options:
--name <name> New human-readable role name.
--permissions <permissions> Comma-separated permission keys from the
business's derived catalog (e.g.
`reports:read,reports:write`). Set-replace: the
given list becomes the role's full grant.
-h, --help display help for command
farthershore consumer rbac roles delete
Usage: farthershore consumer rbac roles delete [options] [businessIdOrSlug] <subscriberId> <roleKey>
Delete one subscriber Managed-RBAC role
Options:
--yes Skip confirmation; required for this destructive action
-h, --help display help for command