CLI: organization

farthershore organization#

Usage: farthershore organization [options] [command]

Manage builder organizations and team membership

Options:
  -h, --help                                                      display help for command

Commands:
  list                                                            List builder organizations available to the caller
  create [options] <name>                                         Create a team or company organization
  role
  members [options] <organizationId>                              List organization members
  invite [options] <organizationId> <email>                       Invite a member to an organization
  invitation-list                                                 List the caller's pending organization invitations
  invitation-list-sent <organizationId>                           List an organization's outstanding sent invitations
  invitation-revoke [options] <organizationId> <invitationId>     Revoke a pending organization invitation
  invitation-accept [options] <invitationId>                      Accept an organization invitation
  member-role [options] <organizationId> <memberUserId>           Change an organization member's role
  member-remove [options] <organizationId> <memberUserId>         Remove a member from an organization
  ownership-transfer [options] <organizationId> <newOwnerUserId>  Transfer primary ownership of a team or company organization to another member
  delete [options] <organizationId>                               Delete an organization and its managed state
  overview <organizationId>                                       Read the organization overview shown on the dashboard
  bulletin [options] <organizationId>                             List the consolidated bulletin across the organization
  help [command]                                                  display help for command

farthershore organization list#

Usage: farthershore organization list [options]

List builder organizations available to the caller

Options:
  -h, --help  display help for command

farthershore organization create#

Usage: farthershore organization create [options] <name>

Create a team or company organization

Options:
  --type <type>            Organization type: team | company (default: "team")
  --idempotency-key <key>  Required for this mutation. Generate it once and
                           reuse the exact value on retry.
  -h, --help               display help for command

farthershore organization role#

Usage: farthershore organization role [options] [command]

Options:
  -h, --help                                   display help for command

Commands:
  list [options] <organizationId>              List the roles available in an organization
  show <organizationId> <roleKey>              Show one organization role and its exact permissions
  create [options] <organizationId> <roleKey>  Create a custom organization role
  update [options] <organizationId> <roleKey>  Update a built-in or custom organization role
  delete [options] <organizationId> <roleKey>  Delete an unused custom organization role
  help [command]                               display help for command

farthershore organization role list#

Usage: farthershore organization role list [options] <organizationId>

List the roles available in an organization

Options:
  --filter <field=value>     Exact field filter; repeat for AND. Fields: key,
                             name, builtIn. (default: [])
  --sort <field[:asc|desc]>  Server-side sort (default asc). Fields: key, name,
                             createdAt, id.
  --search <text>            Server-side case-insensitive text search.
  -h, --help                 display help for command

farthershore organization role show#

Usage: farthershore organization role show [options] <organizationId> <roleKey>

Show one organization role and its exact permissions

Options:
  -h, --help  display help for command

farthershore organization role create#

Usage: farthershore organization role create [options] <organizationId> <roleKey>

Create a custom organization role

Options:
  --name <name>
  --description <description>
  --permissions <json>         Exact permission snapshot as JSON, for example
                               ["business:read"]. Use [] for no permissions.
  --idempotency-key <key>      Required for this mutation. Generate it once and
                               reuse the exact value on retry.
  -h, --help                   display help for command

farthershore organization role update#

Usage: farthershore organization role update [options] <organizationId> <roleKey>

Update a built-in or custom organization role

Options:
  --name <name>
  --description <description>
  --clear-description          Clear the role description.
  --permissions <json>         Exact permission snapshot as JSON, for example
                               ["business:read"]. Use [] for no permissions.
  -h, --help                   display help for command

farthershore organization role delete#

Usage: farthershore organization role delete [options] <organizationId> <roleKey>

Delete an unused custom organization role

Options:
  --yes       Skip confirmation; required for this destructive action
  -h, --help  display help for command

farthershore organization members#

Usage: farthershore organization members [options] <organizationId>

List organization members

Options:
  --filter <field=value>     Exact field filter; repeat for AND. Fields: userId,
                             email, roleKey. (default: [])
  --sort <field[:asc|desc]>  Server-side sort (default asc). Fields: userId,
                             email, roleKey, createdAt, updatedAt.
  --search <text>            Server-side case-insensitive text search.
  -h, --help                 display help for command

farthershore organization invite#

Usage: farthershore organization invite [options] <organizationId> <email>

Invite a member to an organization

Options:
  --role <role>            Organization role key (see `organization role list`).
                           (default: "member")
  --idempotency-key <key>  Required for this mutation. Generate it once and
                           reuse the exact value on retry.
  -h, --help               display help for command

farthershore organization invitation-list#

Usage: farthershore organization invitation-list [options]

List the caller's pending organization invitations

Options:
  -h, --help  display help for command

farthershore organization invitation-list-sent#

Usage: farthershore organization invitation-list-sent [options] <organizationId>

List an organization's outstanding sent invitations

Options:
  -h, --help  display help for command

farthershore organization invitation-revoke#

Usage: farthershore organization invitation-revoke [options] <organizationId> <invitationId>

Revoke a pending organization invitation

Options:
  --yes       Skip confirmation; required for this destructive action
  -h, --help  display help for command

farthershore organization invitation-accept#

Usage: farthershore organization invitation-accept [options] <invitationId>

Accept an organization invitation

Options:
  --invitation-token <token>  One-time token from the invitation email, when
                              required.
  -h, --help                  display help for command

farthershore organization member-role#

Usage: farthershore organization member-role [options] <organizationId> <memberUserId>

Change an organization member's role

Options:
  --role <role>  New organization role key (see `organization role list`).
  -h, --help     display help for command

farthershore organization member-remove#

Usage: farthershore organization member-remove [options] <organizationId> <memberUserId>

Remove a member from an organization

Options:
  --yes       Skip confirmation; required for this destructive action
  -h, --help  display help for command

farthershore organization ownership-transfer#

Usage: farthershore organization ownership-transfer [options] <organizationId> <newOwnerUserId>

Transfer primary ownership of a team or company organization to another member

Options:
  --yes                    Skip confirmation; required for this destructive
                           action
  --idempotency-key <key>  Required for this mutation. Generate it once and
                           reuse the exact value on retry.
  -h, --help               display help for command

farthershore organization delete#

Usage: farthershore organization delete [options] <organizationId>

Delete an organization and its managed state

Options:
  --yes       Skip confirmation; required for this destructive action
  -h, --help  display help for command

farthershore organization overview#

Usage: farthershore organization overview [options] <organizationId>

Read the organization overview shown on the dashboard

Options:
  -h, --help  display help for command

farthershore organization bulletin#

Usage: farthershore organization bulletin [options] <organizationId>

List the consolidated bulletin across the organization

Options:
  --kind <kind>
  --status <status>
  --cursor <cursor>
  --limit <count>
  -h, --help         display help for command