Whoami

On this page

Prerequisites

Have a Heex CLI
Have a USER_SECRET_KEY. Should be accessible in your personal space on the heex cloud platform. If you already logged-in you don’t need to add the Api-Key in your command line.

Usage:

./heex whoami [--help]

The whoami command displays information about the current user and workspace.

Available options:

--api-key: Your user api secret_key which can be found on the cloud. [required]
--output-file: The result will be saved into this provided filepath. The output format is json, so please provide a filepath with that format: /path/to/file.json

Usage:

./heex whoami --api-key <USER_SECRET_KEY>

Example output:

{
  "user_name": "jane",
  "owner_id": "w-12345678-1234-1234-1234-123456789abc",
  "workspace_id": "w-87654321-4321-4321-4321-cba987654321"
}

./heex whoami --help