@@ -48,7 +48,7 @@ Database tokens allow for reading and writing data in your {{< product-name omit
48
48
System tokens allow for reading system information and metrics for your server.
49
49
50
50
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
52
52
can use the token string to authenticate ` influxdb3 ` commands and HTTP API requests
53
53
for managing database and system tokens.
54
54
@@ -81,14 +81,18 @@ In your terminal, run the `influxdb3 create token` command and provide the follo
81
81
- ` --permission ` flag to create a token with permissions
82
82
- ` --name ` flag with a unique description of the token
83
83
- _ 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.
85
85
If an expiration isn't set, the token does not expire until revoked.
86
86
- 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.
92
96
93
97
{{% code-placeholders "DATABASE1|DATABASE2|1y" %}}
94
98
@@ -108,7 +112,7 @@ Replace the following:
108
112
your {{% product-name %}} [ database] ( /influxdb3/enterprise/admin/databases/ )
109
113
- {{% code-placeholder-key %}}` 1y ` {{% /code-placeholder-key %}}:
110
114
the token expiration time as a
111
- [ duration] ( /influxdb3/enterprise/reference/glossary/#duration ) .
115
+ duration.
112
116
113
117
The output is the token string in plain text.
114
118
@@ -413,10 +417,14 @@ In your terminal, run the `influxdb3 create token` command and provide the follo
413
417
- ` --permission ` flag to create a token with permissions
414
418
- ` --name ` flag with a unique description of the token
415
419
- _ 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.
417
421
If an expiration isn't set, the token does not expire until revoked.
418
422
- Token permissions in the ` RESOURCE_TYPE:RESOURCE_NAMES:ACTIONS ` format--for example:
419
- - system:health: read
423
+
424
+ ```
425
+ system:health:read
426
+ ```
427
+
420
428
- `system:`: The `system` resource type, which specifies the token is for system information.
421
429
- `health`: The specific system resource to grant permissions to.
422
430
- `read`: The permission to grant to the token (system tokens are always read-only).
@@ -437,7 +445,7 @@ Replace the following:
437
445
438
446
- {{% code-placeholder-key %}}` 1y ` {{% /code-placeholder-key %}}:
439
447
the token expiration time as a
440
- [ duration] ( /influxdb3/enterprise/reference/glossary/#duration ) .
448
+ duration.
441
449
442
450
The output is the token string in plain text.
443
451
@@ -506,7 +514,7 @@ token string in plain text.
506
514
507
515
The ` influxdb3 create token ` command supports the ` --format json ` option.
508
516
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 `
510
518
with your command to format the output as JSON.
511
519
512
520
The ` /api/v3/configure/token ` endpoint outputs JSON format in the response body.
0 commit comments