Skip to content

Commit 2318cf7

Browse files
jstirnamanjstirnaman
committed
feat(mono): 3.1 admin tokens:
- Updates get-started and admin guides, CLI references - Adds admin token CLI reference page - Operator token (_admin) - system-generated, non-expiring - Named admin tokens - user-defined with expiration support - Resource tokens (Enterprise only) - database and system tokens - Core vs Enterprise token limits properly documented - Create the initial operator token
1 parent 7c989a0 commit 2318cf7

File tree

29 files changed

+451
-388
lines changed

29 files changed

+451
-388
lines changed

‎content/influxdb3/core/admin/tokens/_index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: Manage tokens
33
description: >
4-
Manage tokens to authenticate and authorize access to resources and data in an {{< product-name >}} instance.
4+
Manage tokens to authenticate and authorize access to server actions, resources, and data in an {{< product-name >}} instance.
55
menu:
66
influxdb3_core:
77
parent: Administer InfluxDB
@@ -11,4 +11,4 @@ source: /shared/influxdb3-admin/tokens/_index.md
1111

1212
<!-- The content for this page is at
1313
// SOURCE content/shared/influxdb3-admin/tokens/_index.md
14-
-->>
14+
-->

‎content/influxdb3/core/admin/tokens/admin/_index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,9 +11,9 @@ menu:
1111
name: Admin tokens
1212
weight: 101
1313
influxdb3/core/tags: [tokens]
14-
source: /shared/influxdb3-admin/tokens/_index.md
14+
source: /shared/influxdb3-admin/tokens/admin.md
1515
---
1616

1717
<!-- The content for this page is at
18-
// SOURCE content/shared/influxdb3-admin/tokens/_index.md
18+
// SOURCE content/shared/influxdb3-admin/tokens/admin.md
1919
-->

‎content/influxdb3/core/admin/tokens/admin/create.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: Create an admin token
33
description: >
44
Use the [`influxdb3 create token --admin` command](/influxdb3/core/reference/cli/influxdb3/create/token/)
5-
or the [HTTP API](/influxdb3/core/api/v3/)
5+
or the HTTP API [`/api/v3/configure/token/admin`](influxdb3/core/api/v3/#operation/PostCreateAdminToken) endpoint
66
to create an [admin token](/influxdb3/core/admin/tokens/admin/) for your {{< product-name omit="Clustered" >}} instance.
77
An admin token grants access to all actions on the server.
88
menu:

‎content/influxdb3/core/admin/tokens/admin/regenerate.md

Lines changed: 10 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,8 @@
22
title: Regenerate an admin token
33
description: >
44
Use the [`influxdb3 create token --admin` command](/influxdb3/core/reference/cli/influxdb3/create/token/)
5-
or the [HTTP API](/influxdb3/core/api/v3/)
6-
to regenerate an [admin token](/influxdb3/core/admin/tokens/admin/) for your {{< product-name omit="Clustered" >}} instance.
5+
or the HTTP API [`/api/v3/configure/token/admin/regenerate`](/influxdb3/core/api/v3/#operation/PostRegenerateAdminToken) endpoint
6+
to regenerate an [operator token](/influxdb3/core/admin/tokens/admin/) for your {{< product-name omit="Clustered" >}} instance.
77
An admin token grants access to all actions on the server.
88
Regenerating an admin token deactivates the previous token.
99
menu:
@@ -14,8 +14,15 @@ list_code_example: |
1414
##### CLI
1515
```bash
1616
influxdb3 create token --admin \
17-
--token ADMIN_TOKEN \
1817
--regenerate
18+
OPERATOR_TOKEN
19+
```
20+
#### HTTP API
21+
```bash
22+
curl -X POST "http://{{< influxdb/host >}}/api/v3/configure/token/admin/regenerate" \
23+
--header 'Authorization Bearer OPERATOR_TOKEN' \
24+
--header 'Accept: application/json'
25+
--header 'Content-Type: application/json'
1926
```
2027
source: /shared/influxdb3-admin/tokens/admin/regenerate.md
2128
---

‎content/influxdb3/core/reference/cli/influxdb3/create/token.md renamed to ‎content/influxdb3/core/reference/cli/influxdb3/create/token/_index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,9 +7,9 @@ menu:
77
parent: influxdb3 create
88
name: influxdb3 create token
99
weight: 400
10-
source: /shared/influxdb3-cli/create/token.md
10+
source: /shared/influxdb3-cli/create/token/_index.md
1111
---
1212

1313
<!-- The content for this page is at
14-
// SOURCE content/shared/influxdb3-cli/create/token.md
14+
// SOURCE content/shared/influxdb3-cli/create/token/_index.md
1515
-->

‎content/influxdb3/core/reference/cli/influxdb3/create/token/admin.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
---
2+
title: influxdb3 create token admin
3+
description: >
4+
The `influxdb3 create token --admin` command creates a new operator or named
5+
admin authentication token.
6+
menu:
7+
influxdb3_core:
8+
parent: influxdb3 create token
9+
name: influxdb3 create token admin
10+
weight: 400
11+
source: /shared/influxdb3-cli/create/token/admin.md
12+
---
13+
14+
<!-- The content for this page is at
15+
// SOURCE content/shared/influxdb3-cli/create/token/admin.md
16+
-->

‎content/influxdb3/enterprise/admin/tokens/_index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: Manage tokens
33
description: >
4-
Manage tokens to authenticate and authorize access to resources and data in an {{< product-name >}} instance.
4+
Manage tokens to authenticate and authorize access to server actions, resources, and data in an {{< product-name >}} instance.
55
menu:
66
influxdb3_enterprise:
77
parent: Administer InfluxDB

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

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,8 @@
22
title: Create an admin token
33
description: >
44
Use the [`influxdb3 create token --admin` command](/influxdb3/enterprise/reference/cli/influxdb3/create/token/)
5-
or the [HTTP API](/influxdb3/enterprise/api/v3/)
6-
to create an [admin token](/influxdb3/enterprise/admin/tokens/admin/) for your {{< product-name omit="Clustered" >}} instance.
5+
or the HTTP API [`/api/v3/configure/token/admin`](/influxdb3/enterprise/api/v3/#operation/PostCreateAdminToken)
6+
endpoint to create an operator or named [admin token](/influxdb3/enterprise/admin/tokens/admin/) for your {{< product-name omit="Clustered" >}} instance.
77
An admin token grants access to all actions on the server.
88
menu:
99
influxdb3_enterprise:
@@ -12,13 +12,15 @@ weight: 201
1212
list_code_example: |
1313
##### CLI
1414
```bash
15-
influxdb3 create token --admin
15+
influxdb3 create token --admin --name TOKEN_NAME
1616
```
1717
#### HTTP API
1818
```bash
1919
curl -X POST "http://{{< influxdb/host >}}/api/v3/configure/token/admin" \
20-
--header 'Accept: application/json' \
21-
--header 'Content-Type: application/json'
20+
--header 'Authorization Bearer ADMIN_TOKEN' \
21+
--json '{
22+
"name": "TOKEN_NAME"
23+
}'
2224
```
2325
alt_links:
2426
cloud-dedicated: /influxdb3/cloud-dedicated/admin/tokens/create-token/

‎content/influxdb3/enterprise/admin/tokens/admin/regenerate.md

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
---
2-
title: Regenerate an admin token
2+
title: Regenerate an operator admin token
33
description: >
44
Use the [`influxdb3 create token --admin` command](/influxdb3/enterprise/reference/cli/influxdb3/create/token/)
55
or the [HTTP API](/influxdb3/enterprise/api/v3/)
66
to regenerate an [admin token](/influxdb3/enterprise/admin/tokens/admin/) for your {{< product-name omit="Clustered" >}} instance.
7-
An admin token grants access to all actions on the server.
7+
An operator token grants access to all actions on the server.
88
Regenerating an admin token deactivates the previous token.
99
menu:
1010
influxdb3_enterprise:
@@ -14,9 +14,15 @@ list_code_example: |
1414
##### CLI
1515
```bash
1616
influxdb3 create token --admin \
17-
--token ADMIN_TOKEN \
17+
--token OPERATOR_TOKEN \
1818
--regenerate
1919
```
20+
21+
#### HTTP API
22+
```bash
23+
curl -X POST "http://{{< influxdb/host >}}/api/v3/configure/token/admin/regenerate" \
24+
--header 'Authorization Bearer OPERATOR_TOKEN'
25+
```
2026
source: /shared/influxdb3-admin/tokens/admin/regenerate.md
2127
---
2228

‎content/influxdb3/enterprise/admin/tokens/resource/_index.md

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ title: Manage resource tokens
33
seotitle: Manage resource tokens in {{< product-name >}}
44
description: >
55
Manage resource tokens in your {{< product-name >}} instance.
6-
Resource tokens grant fine-grained permissions on resources, such as databases
6+
Resource tokens grant permissions on specific resources, such as databases
77
and system information endpoints in your {{< product-name >}} instance.
88
Database resource tokens allow for actions like writing and querying data.
99
menu:
@@ -15,13 +15,12 @@ influxdb3/enterprise/tags: [tokens]
1515
---
1616

1717
Manage resource tokens in your {{< product-name >}} instance.
18-
Resource tokens grant fine-grained permissions on resources, such as databases
19-
and system information endpoints in your {{< product-name >}} instance.
20-
21-
- **Databases**: Database tokens allow for actions like writing and querying data.
18+
Resource tokens provide scoped access to specific resources:
2219

23-
- **System resources**: System information tokens allow read access to server runtime statistics and health.
24-
Access controls for system information API endpoints help prevent information leaks and attacks (such as DoS).
20+
- **Database tokens**: provide access to specific databases for actions like writing and querying data
21+
- **System tokens**: provide access to system-level resources, such as API endpoints for server runtime statistics and health.
22+
23+
Resource tokens are user-defined and available only in {{% product-name %}}.
2524

2625
{{< children depth="1" >}}
2726

0 commit comments

Comments
 (0)