CLI: service-account

farthershore service-account#

Usage: farthershore service-account [options] [command]

Manage subscriber-owned service accounts using an ephemeral portal consumer
session

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

Commands:
  list [options] <businessId>                       List managed service accounts and pending changes
  create [options] <businessId> <name>              Create or request approval for a managed service account
  update [options] <businessId> <serviceAccountId>  Replace a service account's grants or request approval for the change
  approvals [options] <businessId>                  List pending managed service-account approval requests
  approve [options] <businessId> <approvalId>       Approve a service-account request, optionally trimming its grants
  deny [options] <businessId> <approvalId>          Deny a managed service-account approval request
  rotate [options] <businessId> <serviceAccountId>  Rotate a service account and reveal its replacement key once
  revoke [options] <businessId> <serviceAccountId>  Permanently revoke a service account and all active keys
  help [command]                                    display help for command

farthershore service-account list#

Usage: farthershore service-account list [options] <businessId>

List managed service accounts and pending changes

Options:
  --limit <count>                   Maximum rows (1-100; default 100)
  --offset <count>                  Rows to skip (default 0)
  --environment-id <uuid>           Portal environment UUID (or
                                    FARTHERSHORE_ENVIRONMENT_ID).
  --subscriber-organization <uuid>  Subscriber organization UUID (or
                                    FARTHERSHORE_SUBSCRIBER_ORGANIZATION_ID).
  -h, --help                        display help for command

farthershore service-account create#

Usage: farthershore service-account create [options] <businessId> <name>

Create or request approval for a managed service account

Options:
  --permissions <json>              Exact permission set, for example
                                    ["route:read"].
  --scopes <json>                   Optional exact scope strings as a JSON
                                    array.
  --idempotency-key <key>           Stable replay key. Reuse the same value when
                                    retrying this provisioning request.
  --environment-id <uuid>           Portal environment UUID (or
                                    FARTHERSHORE_ENVIRONMENT_ID).
  --subscriber-organization <uuid>  Subscriber organization UUID (or
                                    FARTHERSHORE_SUBSCRIBER_ORGANIZATION_ID).
  -h, --help                        display help for command

farthershore service-account update#

Usage: farthershore service-account update [options] <businessId> <serviceAccountId>

Replace a service account's grants or request approval for the change

Options:
  --permissions <json>              Exact replacement permission set.
  --idempotency-key <key>           Stable replay key. Reuse the same value when
                                    retrying this provisioning request.
  --environment-id <uuid>           Portal environment UUID (or
                                    FARTHERSHORE_ENVIRONMENT_ID).
  --subscriber-organization <uuid>  Subscriber organization UUID (or
                                    FARTHERSHORE_SUBSCRIBER_ORGANIZATION_ID).
  -h, --help                        display help for command

farthershore service-account approvals#

Usage: farthershore service-account approvals [options] <businessId>

List pending managed service-account approval requests

Options:
  --limit <count>                   Maximum rows (1-100; default 100)
  --offset <count>                  Rows to skip (default 0)
  --environment-id <uuid>           Portal environment UUID (or
                                    FARTHERSHORE_ENVIRONMENT_ID).
  --subscriber-organization <uuid>  Subscriber organization UUID (or
                                    FARTHERSHORE_SUBSCRIBER_ORGANIZATION_ID).
  -h, --help                        display help for command

farthershore service-account approve#

Usage: farthershore service-account approve [options] <businessId> <approvalId>

Approve a service-account request, optionally trimming its grants

Options:
  --permissions <json>              Optional approved subset. Omit to approve
                                    the complete request.
  --environment-id <uuid>           Portal environment UUID (or
                                    FARTHERSHORE_ENVIRONMENT_ID).
  --subscriber-organization <uuid>  Subscriber organization UUID (or
                                    FARTHERSHORE_SUBSCRIBER_ORGANIZATION_ID).
  -h, --help                        display help for command

farthershore service-account deny#

Usage: farthershore service-account deny [options] <businessId> <approvalId>

Deny a managed service-account approval request

Options:
  --environment-id <uuid>           Portal environment UUID (or
                                    FARTHERSHORE_ENVIRONMENT_ID).
  --subscriber-organization <uuid>  Subscriber organization UUID (or
                                    FARTHERSHORE_SUBSCRIBER_ORGANIZATION_ID).
  -h, --help                        display help for command

farthershore service-account rotate#

Usage: farthershore service-account rotate [options] <businessId> <serviceAccountId>

Rotate a service account and reveal its replacement key once

Options:
  --idempotency-key <key>           Required live-attempt key. Reuse the exact
                                    value on retry.
  --environment-id <uuid>           Portal environment UUID (or
                                    FARTHERSHORE_ENVIRONMENT_ID).
  --subscriber-organization <uuid>  Subscriber organization UUID (or
                                    FARTHERSHORE_SUBSCRIBER_ORGANIZATION_ID).
  -h, --help                        display help for command

farthershore service-account revoke#

Usage: farthershore service-account revoke [options] <businessId> <serviceAccountId>

Permanently revoke a service account and all active keys

Options:
  --yes                             Confirm the destructive revocation
  --environment-id <uuid>           Portal environment UUID (or
                                    FARTHERSHORE_ENVIRONMENT_ID).
  --subscriber-organization <uuid>  Subscriber organization UUID (or
                                    FARTHERSHORE_SUBSCRIBER_ORGANIZATION_ID).
  -h, --help                        display help for command