milesoft account

Retrieve details, branding configurations, and list/manage accounts.

milesoft account list

Retrieve a paginated collection of accounts currently active in the ecosystem.

  • Usage: milesoft account list [flags]
Examples
Terminal TTY Tabular Output (Default)
$ milesoft account list
================================================================================================================
ACCOUNT ID           NAME                                   STATUS     CREATED             UPDATED            
================================================================================================================
acc-123-prod         Acme Corporation                       Active     2026-07-10 12:00:00 2026-07-15 14:30:00
acc-456-test         Globex Industries                      Disabled   2026-07-12 09:15:00 2026-07-12 09:15:00
================================================================================================================
End of collection (limit 50)
Automated JSON Output (via Pipe, Redirect, or --json)
$ milesoft account list --json

JSON Schema Result:

[
  {
    "id": "acc-123-prod",
    "name": "Acme Corporation",
    "website": "https://acme.com",
    "branding": {
      "primaryColor": "#2b6cb0",
      "secondaryColor": "#1a365d",
      "logoUrl": "https://acme.com/logo.png"
    },
    "code": "ACME",
    "disabled": false,
    "created": "2026-07-10T12:00:00Z",
    "updated": "2026-07-15T14:30:00Z"
  },
  {
    "id": "acc-456-test",
    "name": "Globex Industries",
    "website": "https://globex.com",
    "branding": {
      "primaryColor": "#e53e3e",
      "secondaryColor": "#742a2a",
      "logoUrl": "https://globex.com/logo.png"
    },
    "code": "GLOBEX",
    "disabled": true,
    "created": "2026-07-12T09:15:00Z",
    "updated": "2026-07-12T09:15:00Z"
  }
]

milesoft account get

Retrieve the full details of a specific account by its unique ID.

  • Usage: milesoft account get <account-id> [flags]
Examples
Terminal TTY Output (Default)
$ milesoft account get acc-123-prod
=========================================================================
             Account
=========================================================================
ID:            acc-123-prod
Name:          Acme Corporation
Website:       https://acme.com
Code:          ACME
Disabled:      false
Logo URL:      https://acme.com/logo.png
Primary Color: #2b6cb0
Secondary Color: #1a365d
-------------------------------------------------------------------------
Created:       2026-07-10T12:00:00Z
Updated:       2026-07-15T14:30:00Z
=========================================================================
Automated JSON Output (via Pipe, Redirect, or --json)
$ milesoft account get acc-123-prod --json

JSON Schema Result:

{
  "id": "acc-123-prod",
  "name": "Acme Corporation",
  "website": "https://acme.com",
  "branding": {
    "primaryColor": "#2b6cb0",
    "secondaryColor": "#1a365d",
    "logoUrl": "https://acme.com/logo.png"
  },
  "code": "ACME",
  "disabled": false,
  "created": "2026-07-10T12:00:00Z",
  "updated": "2026-07-15T14:30:00Z"
}
Field-Specific Raw Output (via --field Flag)

Pairs perfectly with shell utilities (like pbcopy, env assignments, or scripting) by performing a case-insensitive match and outputting the raw, unquoted value.

$ milesoft account get acc-123-prod --field name
Acme Corporation

$ milesoft account get acc-123-prod --field branding.logoUrl
https://acme.com/logo.png

milesoft account create

Provisions a new tenant account with support for custom metadata and branding configurations.

  • Usage: milesoft account create [flags]
  • Sub-flags:
    • --name string (Required): Name of the account.
    • --allow-join (Default: true): Whether users are allowed to self-join the account.
    • --disabled: Whether the account is disabled.
    • --logo-url string: Logo image URL of the account branding.
    • --primary-color string (Default: "#2b6cb0"): Primary color of the account branding.
    • --secondary-color string (Default: "#1a365d"): Secondary color of the account branding.
    • --website string: Website URL of the account.
Examples
Provisioning an Account with Branding
$ milesoft account create --name "Initech Corp" --website "https://initech.com" --logo-url "https://initech.com/logo.png"
=========================================================================
             Created Account
=========================================================================
Account ID:  acc-789-new
Name:        Initech Corp
Website:     https://initech.com
Code:        INITECH
Disabled:    false
Logo URL:      https://initech.com/logo.png
Primary Color: #2b6cb0
Secondary Color: #1a365d
Created:     2026-07-17T15:20:00Z
Updated:     2026-07-17T15:20:00Z
=========================================================================
JSON Response for Scripted Creation (using --json)
$ milesoft account create --name "Initech Corp" --website "https://initech.com" --json

JSON Schema Result:

{
  "id": "acc-789-new",
  "name": "Initech Corp",
  "website": "https://initech.com",
  "branding": {
    "primaryColor": "#2b6cb0",
    "secondaryColor": "#1a365d",
    "logoUrl": ""
  },
  "code": "INITECH",
  "disabled": false,
  "created": "2026-07-17T15:20:00Z",
  "updated": "2026-07-17T15:20:00Z"
}

milesoft account update

Perform surgical partial modifications on account metadata or branding. At least one modification flag must be explicitly provided, otherwise the command will fail.

  • Usage: milesoft account update <account-id> [flags]
  • Sub-flags:
    • --name string: New name of the account.
    • --allow-join (Default: true): Allow or disallow users to self-join the account.
    • --disabled: Disable or enable the account.
    • --logo-url string: New logo image URL of the account branding.
    • --primary-color string: New primary color of the account branding.
    • --secondary-color string: New secondary color of the account branding.
    • --website string: New website URL of the account.
Examples
Updating Account Metadata
$ milesoft account update acc-789-new --name "Initech Inc." --primary-color "#e53e3e"
=========================================================================
             Updated Account
=========================================================================
Account ID:  acc-789-new
Name:        Initech Inc.
Website:     https://initech.com
Code:        INITECH
Disabled:    false
Primary Color: #e53e3e
Secondary Color: #1a365d
-------------------------------------------------------------------------
Created:     2026-07-17T15:20:00Z
Updated:     2026-07-17T15:25:00Z
=========================================================================
JSON Response for Scripted Update (using --json)
$ milesoft account update acc-789-new --disabled --json

JSON Schema Result:

{
  "id": "acc-789-new",
  "name": "Initech Inc.",
  "website": "https://initech.com",
  "branding": {
    "primaryColor": "#e53e3e",
    "secondaryColor": "#1a365d",
    "logoUrl": ""
  },
  "code": "INITECH",
  "disabled": true,
  "created": "2026-07-17T15:20:00Z",
  "updated": "2026-07-17T15:30:00Z"
}

milesoft account delete

Permanently delete an existing account. To prevent accidental data loss in production, this command interactively prompts the user for confirmation unless bypassed using the global -y/--yes flag.

  • Usage: milesoft account delete <account-id> [flags]
Examples
Deleting Interactively
$ milesoft account delete acc-789-new
Are you sure you want to delete account acc-789-new? (y/N): y
Success! Account acc-789-new has been deleted.
Interactive Delete Cancellation
$ milesoft account delete acc-789-new
Are you sure you want to delete account acc-789-new? (y/N): n
Delete cancelled.
Bypassing Prompts for Automation
$ milesoft account delete acc-789-new --yes
Success! Account acc-789-new has been deleted.