Skip to content
HyperlakeHyperlake

Authenticate

Use an API key or access token issued by your Hyperlake administrator. Prefer an environment variable or interactive input in automation so the secret is not embedded in shell history.

Terminal window
export HYPERLAKE_API_KEY='your-key'
hyperlake auth login \
  --host https://your-tenant.hyperlake.cloud \
  --email you@example.com \
  --api-key "$HYPERLAKE_API_KEY"

Check the active identity:

Terminal window
hyperlake auth whoami

The output includes the authenticated identity and tenant context, but not the credential value.

Terminal window
hyperlake auth whoami --json