influxdata / influxdata/docs-v2

CLI docs don't specify that to create a token you need a username

Open
#3,816 1 comment 0 reactions 0 assignees View on GitHub
product:v2-cloud
Dominant language
JavaScript
Stars
82
Forks
326
Avg merge
1d 1h
Merged PRs (30d)
82

Description

I was testing the CLI to create an authentication token, following the docs in https://docs.influxdata.com/influxdb/cloud/security/tokens/create-token/#create-a-token-using-the-influx-cli and https://docs.influxdata.com/influxdb/cloud/reference/cli/influx/auth/create/

I kept getting an error:
`Error: could not find user with name "": %!w().`

It turns out that you have to provide a username:
`influx authorization create --read-buckets --org-id 8ebf5208251c5eb3 -u wbaker@influxdata.com`
but I didn't see anything in the docs that indicated that, and it wasn't included in any of the examples.

Contributor guide

No contributing guide indexed for this repository

Research direction

Start with the linked token-creation and `influx auth create` documentation pages. Update the guidance and examples to state that a username is required and show the `-u` option; the work is done when users can find that requirement before running the command.

Written by the indexing model from the issue text.

Assessment

Domain
cli, documentation
Issue type
Documentation
Difficulty
1/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.