Skip to main content

band auth login

Log in with Bandwidth OAuth2 client credentials

Synopsis

Authenticate with Bandwidth API client credentials.

Only a client ID and secret are required — the CLI will automatically discover which accounts the credentials can access.

band auth login --client-id --client-secret band auth login --client-id --client-secret --profile admin

Or via environment variables:

BW_CLIENT_ID= BW_CLIENT_SECRET= band auth login

band auth login [flags]

Examples

# Interactive login
band auth login

# Non-interactive with flags
band auth login --client-id CLI-abc123 --client-secret mySecret

# Non-interactive with env vars
BW_CLIENT_ID=CLI-abc123 BW_CLIENT_SECRET=mySecret band auth login

# Store under a named profile
band auth login --client-id CLI-abc123 --client-secret mySecret --profile admin

Options

--client-id string Bandwidth OAuth2 client ID
--client-secret string Bandwidth OAuth2 client secret
-h, --help help for login
--profile string Profile name to store credentials under (default "default")

Options inherited from parent commands

--account-id string Bandwidth account ID (overrides config)
--environment string API environment: prod, test (overrides config)
--format string Output format: json or table (default "json")
--plain Simplified flat JSON output (recommended for scripts and agents)

SEE ALSO

  • band auth - Manage authentication credentials