chore(influxdb3): Core and Enterprise resource tokens: Move from /shared to /enterprise. Apply suggestions from @jdstrand

pull/6005/head
Jason Stirnaman 2025-04-21 13:57:13 -05:00
parent 80de38933c
commit 1069f31c9f
2 changed files with 23 additions and 18 deletions

View File

@ -3,7 +3,7 @@ title: Manage resource tokens
seotitle: Manage resource tokens in {{< product-name >}}
description: >
Manage resource tokens in your {{< product-name >}} instance.
Resource tokens grant read and write permissions resources, such as databases
Resource tokens grant fine-grained permissions on resources, such as databases
and system information endpoints in your {{< product-name >}} instance.
Database resource tokens allow for actions like writing and querying data.
menu:
@ -14,8 +14,14 @@ weight: 101
influxdb3/enterprise/tags: [tokens]
---
Manage resource tokens in your {{< product-name >}} instance.
Resource tokens grant fine-grained permissions on resources, such as databases
and system information endpoints in your {{< product-name >}} instance.
- **Databases**: Database tokens allow for actions like writing and querying data.
- **System resources**: System information tokens allow read access to server runtime statistics and health.
Access controls for system information API endpoints help prevent information leaks and attacks (such as DoS).
{{< children depth="1" >}}
<!-- The content for this page is at
// SOURCE - content/shared/influxdb3-admin/tokens/database/_index.md
-->

View File

@ -3,7 +3,7 @@ title: Create a resource token
description: >
Use the [`influxdb3 create token --permission` command](/influxdb3/enterprise/reference/cli/influxdb3/create/token/)
or the [HTTP API](/influxdb3/enterprise/api/v3/)
to create tokens that grant access to resources such as databases and system information.
to create fine-grained permissions tokens that grant access to resources such as databases and system information.
Database tokens allow for reading and writing data in your {{< product-name omit="Clustered" >}} instance.
System tokens allow for reading system information and metrics for your server.
menu:
@ -43,7 +43,7 @@ alt_links:
Use the [`influxdb3 create token --permission` command](/influxdb3/enterprise/reference/cli/influxdb3/create/token/)
or the [`/api/v3/configure/token` HTTP API endpoint](/influxdb3/enterprise/api/v3/)
to create tokens that grant access to resources such as databases and system information.
to create fine-grained permissions tokens that grant access to resources such as databases and system information.
Database tokens allow for reading and writing data in your {{< product-name omit="Clustered" >}} instance.
System tokens allow for reading system information and metrics for your server.
@ -73,15 +73,14 @@ The HTTP API examples in this guide use [cURL](https://curl.se/) to send an API
<!------------------------------- BEGIN INFLUXDB3 ----------------------------->
Use the [`influxdb3 create token` command](/influxdb3/enterprise/reference/cli/influxdb3/create/token/)
to create a database token with permissions for reading and writing data in
to create a database token with fine-grained permissions for reading and writing data in
your {{% product-name %}} instance.
In your terminal, run the `influxdb3 create token` command and provide the following:
In your terminal, run the `influxdb3 create token --permission` command and provide the following:
- `--permission` flag to create a token with permissions
- `--name` flag with a unique description of the token
- `--name`: A unique name for the token
- _Options_, for example:
- `--expiry` option with the token expiration time as a duration.
- `--expiry`: The token expiration time as a duration.
If an expiration isn't set, the token does not expire until revoked.
- Token permissions (read and write) in the `RESOURCE_TYPE:RESOURCE_NAMES:ACTIONS` format--for example:
@ -89,10 +88,10 @@ In your terminal, run the `influxdb3 create token` command and provide the follo
db:DATABASE1,DATABASE2:read,write
```
- `db:`: The `db` resource type, which specifies the token is for a database.
- `DATABASE1,DATABASE2`: The names of the databases to grant permissions to.
- `db:`: The `db` resource type, which specifies the token is for a database
- `DATABASE1,DATABASE2`: A comma-separated list of database names to grant permissions to.
The resource names part supports the `*` wildcard, which grants read or write permissions to all databases.
- `read,write`: The permissions to grant to the token.
- `read,write`: A comma-separated list of permissions to grant to the token.
{{% code-placeholders "DATABASE1|DATABASE2|1y" %}}
@ -412,12 +411,12 @@ Use the [`influxdb3 create token` command](/influxdb3/enterprise/reference/cli/i
to create a system token with permissions for reading system information from
your {{% product-name %}} instance.
In your terminal, run the `influxdb3 create token` command and provide the following:
In your terminal, run the `influxdb3 create token --permission` command and provide the following:
- `--permission` flag to create a token with permissions
- `--name` flag with a unique description of the token
- `--name`: A unique name for the token
- _Options_, for example:
- `--expiry` option with the token expiration time as a duration.
- `--expiry`: The token expiration time as a duration.
If an expiration isn't set, the token does not expire until revoked.
- Token permissions in the `RESOURCE_TYPE:RESOURCE_NAMES:ACTIONS` format--for example: