Skip to navigation

auth Commands

View as Markdown

Manage BCTRL authentication

Output formatting flags (--json, --jq, and --template) are documented once in Output Formatting and are omitted from the tables below.

bctrl auth login

Authenticate with BCTRL

bctrl auth login [flags]
FlagDescription
--with-tokenRead an API key from standard input instead of using the browser device flow
--token-file <path>Read an API key from a file instead of using the browser device flow
--urlStart a browser authorization, print the URL, and exit
--waitPoll until the browser authorization is approved

bctrl auth logout

Remove stored BCTRL credentials

bctrl auth logout

bctrl auth status

Show BCTRL authentication status

bctrl auth status

bctrl auth token

Print the active BCTRL API key

bctrl auth token [flags]
FlagDescription
--revealAllow printing the API key to a terminal

bctrl auth whoami

Return the API key actor for the current request. Use this to validate CLI credentials and show whether the key is scoped to an organization or subaccount.

bctrl auth whoami [flags]
FlagDescription
--headers <json>API headers: inline JSON, @file, or - for stdin
--api-version <date>Dated API contract (default: 2026-10-03)
--space <id-or-name>Select an authorized Space (BCTRL-Space)
--subaccount-id <id>Effective subaccount context (BCTRL-Subaccount-Id)