Documentation

influx user update

Works with InfluxDB OSS 2.x

The influx user update command updates users in InfluxDB OSS 2.x, but does not update users in InfluxDB Cloud. Use the InfluxDB Cloud user interface to update account information.

The influx user update command updates information related to a user in InfluxDB.

Usage

influx user update [flags]

Flags

FlagDescriptionInput typeMaps to ?
-c--active-configCLI configuration to use for commandstring
--configs-pathPath to influx CLI configurations (default ~/.influxdbv2/configs)stringINFLUX_CONFIGS_PATH
-h--helpHelp for the update command
--hide-headersHide table headers (default false)INFLUX_HIDE_HEADERS
--hostHTTP address of InfluxDB (default http://localhost:8086)stringINFLUX_HOST
-i--id(Required) User IDstring
--jsonOutput data as JSON (default false)INFLUX_OUTPUT_JSON
-n--nameUsernamestring
--skip-verifySkip TLS certificate verificationINFLUX_SKIP_VERIFY
-t--tokenAPI tokenstringINFLUX_TOKEN

Examples

Authentication credentials

The examples below assume your InfluxDB host, organization, and token are provided by either the active influx CLI configuration or by environment variables (INFLUX_HOST, INFLUX_ORG, and INFLUX_TOKEN). If you do not have a CLI configuration set up or the environment variables set, include these required credentials for each command with the following flags:

  • --host: InfluxDB host
  • -o, --org or --org-id: InfluxDB organization name or ID
  • -t, --token: InfluxDB API token
Update a username
influx user update \
  --id 0Xx0oox00XXoxxoo1 \
  --name new-username

Was this page helpful?

Thank you for your feedback!


The future of Flux

Flux is going into maintenance mode. You can continue using it as you currently are without any changes to your code.

Read more

InfluxDB Cloud powered by TSM