Documentation

influx user update

Available with InfluxDB OSS 2.x only

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 the active influx CLI configuration. If you do not have a CLI configuration set up, use the appropriate flags to provide these required credentials.

Update a username
influx user update \
  --id 0Xx0oox00XXoxxoo1 \
  --name new-username

Select your region

Upgrade to InfluxDB Cloud or InfluxDB 2.0!

InfluxDB Cloud and InfluxDB OSS 2.0 ready for production.