influx user update
- influx CLI 2.0.0+
- InfluxDB 2.0.0+
The influx user update
command updates information related to a user in InfluxDB.
Usage
influx user update [flags]
Flags
Flag | Description | Input type | Maps to ? | |
---|---|---|---|---|
-c | —active-config | CLI configuration to use for command | string | |
—configs-path | Path to influx CLI configurations (default ~/.influxdbv2/configs ) | string | INFLUX_CONFIGS_PATH | |
-h | —help | Help for the update command | ||
—hide-headers | Hide table headers (default false ) | INFLUX_HIDE_HEADERS | ||
—host | HTTP address of InfluxDB (default http://localhost:8086 ) | string | INFLUX_HOST | |
-i | —id | (Required) User ID | string | |
—json | Output data as JSON (default false ) | INFLUX_OUTPUT_JSON | ||
-n | —name | Username | string | |
—skip-verify | Skip TLS certificate verification | INFLUX_SKIP_VERIFY | ||
-t | —token | API token | string | INFLUX_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
Related
- Manage users
- influx CLI—Provide required authentication credentials
- influx CLI—Flag patterns and conventions