Skip to content

Commit 67cfc27

Browse files
authored
Merge pull request #5985 from influxdata/hotfix-create-resource-token
hotfix: admin/tokens path, format permissions, remove glossary link
2 parents ab802aa + 1d6d58a commit 67cfc27

File tree

1 file changed

+20
-12
lines changed
  • content/influxdb3/enterprise/admin/tokens/resource

1 file changed

+20
-12
lines changed

content/influxdb3/enterprise/admin/tokens/resource/create.md

Lines changed: 20 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ Database tokens allow for reading and writing data in your {{< product-name omit
4848
System tokens allow for reading system information and metrics for your server.
4949

5050
After you
51-
[create an _admin token_](/influxdb3/enterprise/admin/token/admin/create/), you
51+
[create an _admin token_](/influxdb3/enterprise/admin/tokens/admin/create/), you
5252
can use the token string to authenticate `influxdb3` commands and HTTP API requests
5353
for managing database and system tokens.
5454

@@ -81,14 +81,18 @@ In your terminal, run the `influxdb3 create token` command and provide the follo
8181
- `--permission` flag to create a token with permissions
8282
- `--name` flag with a unique description of the token
8383
- _Options_, for example:
84-
- `--expiry` option with the token expiration time as a [duration](/influxdb3/enterprise/reference/glossary/#duration).
84+
- `--expiry` option with the token expiration time as a duration.
8585
If an expiration isn't set, the token does not expire until revoked.
8686
- Token permissions (read and write) in the `RESOURCE_TYPE:RESOURCE_NAMES:ACTIONS` format--for example:
87-
- db:DATABASE1,DATABASE2:read,write
88-
- `db:`: The `db` resource type, which specifies the token is for a database.
89-
- `DATABASE1,DATABASE2`: The names of the databases to grant permissions to.
90-
The resource names part supports the `*` wildcard, which grants read or write permissions to all databases.
91-
- `read,write`: The permissions to grant to the token.
87+
88+
```
89+
db:DATABASE1,DATABASE2:read,write
90+
```
91+
92+
- `db:`: The `db` resource type, which specifies the token is for a database.
93+
- `DATABASE1,DATABASE2`: The names of the databases to grant permissions to.
94+
The resource names part supports the `*` wildcard, which grants read or write permissions to all databases.
95+
- `read,write`: The permissions to grant to the token.
9296

9397
{{% code-placeholders "DATABASE1|DATABASE2|1y" %}}
9498

@@ -108,7 +112,7 @@ Replace the following:
108112
your {{% product-name %}} [database](/influxdb3/enterprise/admin/databases/)
109113
- {{% code-placeholder-key %}}`1y`{{% /code-placeholder-key %}}:
110114
the token expiration time as a
111-
[duration](/influxdb3/enterprise/reference/glossary/#duration).
115+
duration.
112116

113117
The output is the token string in plain text.
114118

@@ -413,10 +417,14 @@ In your terminal, run the `influxdb3 create token` command and provide the follo
413417
- `--permission` flag to create a token with permissions
414418
- `--name` flag with a unique description of the token
415419
- _Options_, for example:
416-
- `--expiry` option with the token expiration time as a [duration](/influxdb3/enterprise/reference/glossary/#duration).
420+
- `--expiry` option with the token expiration time as a duration.
417421
If an expiration isn't set, the token does not expire until revoked.
418422
- Token permissions in the `RESOURCE_TYPE:RESOURCE_NAMES:ACTIONS` format--for example:
419-
- system:health:read
423+
424+
```
425+
system:health:read
426+
```
427+
420428
- `system:`: The `system` resource type, which specifies the token is for system information.
421429
- `health`: The specific system resource to grant permissions to.
422430
- `read`: The permission to grant to the token (system tokens are always read-only).
@@ -437,7 +445,7 @@ Replace the following:
437445

438446
- {{% code-placeholder-key %}}`1y`{{% /code-placeholder-key %}}:
439447
the token expiration time as a
440-
[duration](/influxdb3/enterprise/reference/glossary/#duration).
448+
duration.
441449

442450
The output is the token string in plain text.
443451

@@ -506,7 +514,7 @@ token string in plain text.
506514

507515
The `influxdb3 create token` command supports the `--format json` option.
508516
By default, the command outputs the token string.
509-
For [token details](/influxdb3/enterprise/api/management/#operation/CreateDatabaseToken) and easier programmatic access to the command output, include `--format json`
517+
For easier programmatic access to the command output, include `--format json`
510518
with your command to format the output as JSON.
511519

512520
The `/api/v3/configure/token` endpoint outputs JSON format in the response body.

0 commit comments

Comments
 (0)