auth:status
Report who the current access token signs you in as: authenticated, user_id and email (null when not signed in), auth_enabled (whether sign-in is required) and session_capacity (mode, gate_closed, reason, authenticated_session_admitted, public_surface_mode, web_heartbeat_seconds). Session capacity concerns signed-in web sessions, not compute approval sessions.
Reference for flywheel auth:status.
Inspect authentication readiness. When FLYWHEEL_API_KEY or the selected profile's api_key_env supplies authentication, the credential file is not read and credential_store_readiness is not_checked.
Command Group
Auth Commands
Summary
Report who the current access token signs you in as: authenticated, user_id and email (null when not signed in), auth_enabled (whether sign-in is required) and session_capacity (mode, gate_closed, reason, authenticated_session_admitted, public_surface_mode, web_heartbeat_seconds). Session capacity concerns signed-in web sessions, not compute approval sessions.
Effect
read-only
Usage
flywheel auth:status [FLAGS]Aliases
as
Required flags
None.
Optional flags
| Flag | Value | Default | Choices | Description |
|---|---|---|---|---|
--format | FORMAT | json, tsv, csv, table | Output format for command results. | |
--env | PROFILE | Select a CLI profile; unconfigured default requires FLYWHEEL_BASE_URL. | ||
--out | PATH | Write output to a file path, or use - for stdout. | ||
--open | Open browser-bound URLs when supported. | |||
--no-retry | Disable transient-error retries. | |||
--retry-max | N | Maximum transient-error retry attempts. | ||
--wait | Block on async operations until a terminal state is reached. | |||
--wait-timeout | SECONDS | 600 | Seconds to wait for --wait before timing out. Defaults to 600. | |
--allow-self | Allow mutating the currently active credential. | |||
--timeout | SECONDS | Set the per-request timeout budget in seconds. | ||
--idempotency-key | KEY | Reuse an Idempotency-Key so ambiguous write failures can be retried with the same key. | ||
--force | Force safety-gated operations where supported. | |||
--yes | Confirm forced compute:release-all --force. Other runtime commands do not read --yes. | |||
--debug | Print structured request debugging with secrets masked. | |||
--verbose | Print verbose progress for long-running operations. | |||
-h, --help | Show this help. |
Examples
Check whether the current config is authenticated.
flywheel auth:status --format=jsonProduce tab-separated output for script consumption.
flywheel auth:status --format=tsvOutput
Default format: json.
| Field | Type |
|---|---|
authenticated | boolean |
user_id (optional) | string | null |
email (optional) | string | null |
auth_enabled (optional) | boolean |
session_capacity (optional) | object |
auth_method (optional) | "api_key" |
email_unavailable_reason (optional) | "api_key_auth_without_email" |
profile | string |
local_config_readiness | string |
credential_store_readiness | string |
remote_readiness | string |
remediation (optional) | string |