Merge pull request #1713 from influxdata/edit-auth-create-flags

Edit `influx auth create` docs to clarify permissions
pull/1714/head
pierwill 2020-10-26 15:26:43 -05:00 committed by GitHub
commit cb3cc221fe
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 6 additions and 6 deletions

View File

@ -17,17 +17,17 @@ influx auth create [flags]
## Flags ## Flags
| Flag | | Description | Input type | {{< cli/mapped >}} | | Flag | | Description | Input type | {{< cli/mapped >}} |
|:---- |:--- |:----------- |:----------: |:------------------ | |:-----|:---------------------|:----------------------------------------------------------------------|:-----------:|:----------------------|
| `-c` | `--active-config` | CLI configuration to use for command | string | | | `-c` | `--active-config` | CLI configuration to use for command | string | |
| | `--configs-path` | Path to `influx` CLI configurations (default `~/.influxdbv2/configs`) | string |`INFLUX_CONFIGS_PATH` | | | `--configs-path` | Path to `influx` CLI configurations (default `~/.influxdbv2/configs`) | string | `INFLUX_CONFIGS_PATH` |
| `-h` | `--help` | Help for the `create` command | | | | `-h` | `--help` | Help for the `create` command | | |
| | `--hide-headers` | Hide table headers (default `false`) | | `INFLUX_HIDE_HEADERS` | | | `--hide-headers` | Hide table headers (default `false`) | | `INFLUX_HIDE_HEADERS` |
| | `--host` | HTTP address of InfluxDB (default `http://localhost:8086`) | string | `INFLUX_HOST` | | | `--host` | HTTP address of InfluxDB (default `http://localhost:8086`) | string | `INFLUX_HOST` |
| | `--json` | Output data as JSON (default `false`) | | `INFLUX_OUTPUT_JSON` | | | `--json` | Output data as JSON (default `false`) | | `INFLUX_OUTPUT_JSON` |
| `-o` | `--org` | **(Required)** Organization name | string | `INFLUX_ORG` | | `-o` | `--org` | **(Required)** Organization name | string | `INFLUX_ORG` |
| | `--org-id` | Organization ID | string | `INFLUX_ORG_ID` | | | `--org-id` | Organization ID | string | `INFLUX_ORG_ID` |
| | `--read-bucket` | Bucket ID | stringArray | | | | `--read-bucket` | Grants permission to read specified bucket IDs | stringArray | |
| | `--read-buckets` | Grants permission to read organization buckets | | | | | `--read-buckets` | Grants permission to read **all** organization buckets | | |
| | `--read-dashboards` | Grants permission to read dashboards | | | | | `--read-dashboards` | Grants permission to read dashboards | | |
| | `--read-orgs` | Grants permission to read organizations | | | | | `--read-orgs` | Grants permission to read organizations | | |
| | `--read-tasks` | Grants permission to read tasks | | | | | `--read-tasks` | Grants permission to read tasks | | |
@ -36,8 +36,8 @@ influx auth create [flags]
| | `--skip-verify` | Skip TLS certificate verification | | | | | `--skip-verify` | Skip TLS certificate verification | | |
| `-t` | `--token` | Authentication token | string | `INFLUX_TOKEN` | | `-t` | `--token` | Authentication token | string | `INFLUX_TOKEN` |
| `-u` | `--user` | Username | string | | | `-u` | `--user` | Username | string | |
| | `--write-bucket` | Bucket ID | stringArray | | | | `--write-bucket` | Grants permission to write to specified bucket IDs | stringArray | |
| | `--write-buckets` | Grants permission to create and update organization buckets | | | | | `--write-buckets` | Grants permission to create and update **all** organization buckets | | |
| | `--write-dashboards` | Grants permission to create and update dashboards | | | | | `--write-dashboards` | Grants permission to create and update dashboards | | |
| | `--write-orgs` | Grants permission to create and update organizations | | | | | `--write-orgs` | Grants permission to create and update organizations | | |
| | `--write-tasks` | Grants permission to create and update tasks | | | | | `--write-tasks` | Grants permission to create and update tasks | | |