Skip to content

Authentication commands

hyperlake auth login --host URL --email EMAIL [--api-key KEY | --access-token TOKEN]
Option Required Meaning
--host yes Hyperlake tenant/control-plane URL
--email yes Identity associated with the credential
--api-key one of two API key; prefer an environment variable expansion
--access-token one of two Existing bearer token
--json no JSON response where supported

The credential is stored in the local CLI configuration. It is not echoed by whoami or normal list commands.

Terminal window
hyperlake auth whoami
hyperlake auth whoami --json

Returns the authenticated user and tenant context. It does not validate access to every cluster; use clusters list and clusters status for target-specific access.