`milesoft user`

Retrieve details, roles, and list/manage users in assumed accounts.

`milesoft user list`

Retrieve a paginated collection of users currently registered in the current account.

Usage: milesoft user list --account <account-id> [flags]
Flags:
- --account string (Required): Account ID to list users from.

Examples

Terminal TTY Tabular Output (Default)

$ milesoft user list --account acc-123-prod
====================================================================================================
USER ID              FULL NAME / ALIAS                    ADMIN   EMAIL
====================================================================================================
usr-abc-001          John Doe                             X       john@acme.com
usr-def-002          Jane Smith                                   jane.smith@globex.com
usr-ghi-003          Unknown                                      N/A
====================================================================================================
End of collection (limit 50)

Automated JSON Output (via Pipe, Redirect, or `--json`)

$ milesoft user list --account acc-123-prod --json

JSON Schema Result:

[
  {
    "id": "usr-abc-001",
    "firstName": "John",
    "lastName": "Doe",
    "alias": "",
    "email": "john@acme.com",
    "phone": "+1-555-0100",
    "imageUrl": "https://acme.com/avatars/john.png",
    "birthday": "1990-01-15",
    "pending": false,
    "typeId": "usr-type-standard",
    "roles": ["ROLE_ADMIN", "ROLE_USER"],
    "settings": {},
    "created": "2026-07-10T12:00:00Z",
    "updated": "2026-07-15T14:30:00Z"
  },
  {
    "id": "usr-def-002",
    "firstName": "Jane",
    "lastName": "Smith",
    "alias": "",
    "email": "jane.smith@globex.com",
    "phone": "",
    "imageUrl": "",
    "birthday": "",
    "pending": false,
    "typeId": "usr-type-standard",
    "roles": ["ROLE_USER"],
    "settings": {},
    "created": "2026-07-12T09:15:00Z",
    "updated": "2026-07-12T09:15:00Z"
  }
]

`milesoft user get`

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

Usage: milesoft user get <user-id> --account <account-id> [flags]
Flags:
- --account string (Required): Account ID to look up the user in.

Examples

Terminal TTY Output (Default)

$ milesoft user get usr-abc-001 --account acc-123-prod
=========================================================================
              User Details
=========================================================================
ID:            usr-abc-001
First Name:    John
Last Name:     Doe
Alias:
Email:         john@acme.com
Phone:         +1-555-0100
Image URL:     https://acme.com/avatars/john.png
Birthday:      1990-01-15
Pending:       false
Type ID:       usr-type-standard
Roles:         ROLE_ADMIN, ROLE_USER
-------------------------------------------------------------------------
Created:       2026-07-10T12:00:00Z
Updated:       2026-07-15T14:30:00Z
=========================================================================

Automated JSON Output (via Pipe, Redirect, or `--json`)

$ milesoft user get usr-abc-001 --account acc-123-prod --json

JSON Schema Result:

{
  "id": "usr-abc-001",
  "firstName": "John",
  "lastName": "Doe",
  "alias": "",
  "email": "john@acme.com",
  "phone": "+1-555-0100",
  "imageUrl": "https://acme.com/avatars/john.png",
  "birthday": "1990-01-15",
  "pending": false,
  "typeId": "usr-type-standard",
  "roles": ["ROLE_ADMIN", "ROLE_USER"],
  "settings": {},
  "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 user get usr-abc-001 --account acc-123-prod --field email
john@acme.com

$ milesoft user get usr-abc-001 --account acc-123-prod --field roles
[
  "ROLE_ADMIN",
  "ROLE_USER"
]

`milesoft user create`

Provisions a new user within the assumed account. At least one role must be assigned at creation time.

Usage: milesoft user create [flags]
Sub-flags:
- --account string (Required): Account ID to create the user in.
- --email string (Required): User's email address.
- --roles []string (Required): User's roles (at least one required).
- --first-name string: User's first name.
- --last-name string: User's last name.
- --alias string: User's alias/display name.
- --phone string: User's phone number.
- --image-url string: User's image URL.
- --birthday string: User's birthday (YYYY-MM-DD).
- --type-id string: User's type ID.
- --settings string: JSON map for user settings.

Examples

Provisioning a User with Roles

$ milesoft user create --account acc-123-prod --email "bob@initech.com" --roles "ROLE_USER" --first-name "Bob" --last-name "Ross"
=========================================================================
              Created User
=========================================================================
ID:            usr-jkl-004
First Name:    Bob
Last Name:     Ross
Alias:
Email:         bob@initech.com
Phone:
Image URL:
Birthday:
Pending:       false
Type ID:
Roles:         ROLE_USER
-------------------------------------------------------------------------
Created:       2026-07-17T15:20:00Z
Updated:       2026-07-17T15:20:00Z
=========================================================================

JSON Response for Scripted Creation (using `--json`)

$ milesoft user create --account acc-123-prod --email "bob@initech.com" --roles "ROLE_ADMIN,ROLE_USER" --first-name "Bob" --last-name "Ross" --json

JSON Schema Result:

{
  "id": "usr-jkl-004",
  "firstName": "Bob",
  "lastName": "Ross",
  "alias": "",
  "email": "bob@initech.com",
  "phone": "",
  "imageUrl": "",
  "birthday": "",
  "pending": false,
  "typeId": "",
  "roles": ["ROLE_ADMIN", "ROLE_USER"],
  "settings": {},
  "created": "2026-07-17T15:20:00Z",
  "updated": "2026-07-17T15:20:00Z"
}

`milesoft user update`

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

Usage: milesoft user update <user-id> --account <account-id> [flags]
Sub-flags:
- --account string (Required): Account ID to look up the user in.
- --first-name string: New first name of the user.
- --last-name string: New last name of the user.
- --alias string: New alias/display name of the user.
- --email string: New email address of the user.
- --phone string: New phone number of the user.
- --image-url string: New image URL of the user.
- --birthday string: New birthday (YYYY-MM-DD).
- --type-id string: New type ID of the user.
- --add-role []string: Roles to add to the user.
- --remove-role []string: Roles to remove from the user.
- --settings string: JSON map for user settings (replaces existing).

Examples

Updating User Metadata and Roles

$ milesoft user update usr-jkl-004 --account acc-123-prod --first-name "Robert" --add-role "ROLE_ADMIN" --remove-role "ROLE_OTHER"
=========================================================================
              Updated User
=========================================================================
ID:            usr-jkl-004
First Name:    Robert
Last Name:     Ross
Alias:
Email:         bob@initech.com
Phone:
Image URL:
Birthday:
Pending:       false
Type ID:
Roles:         ROLE_ADMIN, ROLE_USER
-------------------------------------------------------------------------
Created:       2026-07-17T15:20:00Z
Updated:       2026-07-17T15:25:00Z
=========================================================================

JSON Response for Scripted Update (using `--json`)

$ milesoft user update usr-jkl-004 --account acc-123-prod --phone "+1-555-9999" --json

JSON Schema Result:

{
  "id": "usr-jkl-004",
  "firstName": "Robert",
  "lastName": "Ross",
  "alias": "",
  "email": "bob@initech.com",
  "phone": "+1-555-9999",
  "imageUrl": "",
  "birthday": "",
  "pending": false,
  "typeId": "",
  "roles": ["ROLE_ADMIN", "ROLE_USER"],
  "settings": {},
  "created": "2026-07-17T15:20:00Z",
  "updated": "2026-07-17T15:30:00Z"
}

`milesoft user delete`

Permanently remove a user from the 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 user delete <user-id> --account <account-id> [flags]
Flags:
- --account string (Required): Account ID to remove the user from.

Examples

Deleting Interactively

$ milesoft user delete usr-jkl-004 --account acc-123-prod
Are you sure you want to remove user usr-jkl-004 from the account? (y/N): y
Success! User usr-jkl-004 has been deleted from the account.

Interactive Delete Cancellation

$ milesoft user delete usr-jkl-004 --account acc-123-prod
Are you sure you want to remove user usr-jkl-004 from the account? (y/N): n
Action cancelled.

Bypassing Prompts for Automation

$ milesoft user delete usr-jkl-004 --account acc-123-prod --yes
Success! User usr-jkl-004 has been deleted from the account.

milesoft user

milesoft user list

Examples

Terminal TTY Tabular Output (Default)

Automated JSON Output (via Pipe, Redirect, or --json)

milesoft user get

Examples

Terminal TTY Output (Default)

Automated JSON Output (via Pipe, Redirect, or --json)

Field-Specific Raw Output (via --field Flag)

milesoft user create

Examples

Provisioning a User with Roles

JSON Response for Scripted Creation (using --json)

milesoft user update

Examples

Updating User Metadata and Roles

JSON Response for Scripted Update (using --json)

milesoft user delete

Examples

Deleting Interactively

Interactive Delete Cancellation

Bypassing Prompts for Automation

`milesoft user`

`milesoft user list`

Automated JSON Output (via Pipe, Redirect, or `--json`)

`milesoft user get`

Automated JSON Output (via Pipe, Redirect, or `--json`)

Field-Specific Raw Output (via `--field` Flag)

`milesoft user create`

JSON Response for Scripted Creation (using `--json`)

`milesoft user update`

JSON Response for Scripted Update (using `--json`)

`milesoft user delete`