Skip to content
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 12 additions & 12 deletions content/influxdb3/enterprise/admin/tokens/resource/create.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,11 +28,11 @@
--header 'Content-Type: application/json' \
--header "Authorization: Bearer AUTH_TOKEN" \
--data '{
"token_name": "Read-write for DATABASE1, DATABASE2",

Check warning on line 31 in content/influxdb3/enterprise/admin/tokens/resource/create.md

View workflow job for this annotation

GitHub Actions / Vale style check

Google.Quotes

Commas and periods go inside quotation marks.
"permissions": [{
"resource_type": "db",

Check warning on line 33 in content/influxdb3/enterprise/admin/tokens/resource/create.md

View workflow job for this annotation

GitHub Actions / Vale style check

Google.Quotes

Commas and periods go inside quotation marks.
"resource_identifier": ["DATABASE1","DATABASE2"],
"resource_names": ["DATABASE1","DATABASE2"],

Check warning on line 34 in content/influxdb3/enterprise/admin/tokens/resource/create.md

View workflow job for this annotation

GitHub Actions / Vale style check

Google.Quotes

Commas and periods go inside quotation marks.
"actions": ["read","write"]

Check warning on line 35 in content/influxdb3/enterprise/admin/tokens/resource/create.md

View workflow job for this annotation

GitHub Actions / Vale style check

Google.Quotes

Commas and periods go inside quotation marks.
}],
"expiry_secs": 300000
}'
Expand Down Expand Up @@ -130,8 +130,8 @@

- `token_name`: a description of the token, unique within the instance
- `resource_type`: the resource type for the token, which is always `db`
- `resource_identifier`: an array of database names to grant permissions to
- The resource identifier field supports the `*` wildcard, which grants read or write
- `resource_names`: an array of database names to grant permissions to
- The `resource_names` field supports the `*` wildcard, which grants read or write
permissions to all databases.
- `permissions`: an array of token permission actions (`"read"`, `"write"`) for the database
- `expiry_secs`: Specify the token expiration time in seconds.
Expand All @@ -149,7 +149,7 @@
"token_name": "Read-write for DATABASE1, DATABASE2",
"permissions": [{
"resource_type": "db",
"resource_identifier": ["DATABASE1","DATABASE2"],
"resource_names": ["DATABASE1","DATABASE2"],
"actions": ["read","write"]
}],
"expiry_secs": 300000
Expand Down Expand Up @@ -211,7 +211,7 @@
"token_name": "Read/write token for DATABASE_NAME",
"permissions": [{
"resource_type": "db",
"resource_identifier": ["DATABASE_NAME"],
"resource_names": ["DATABASE_NAME"],
"actions": ["read","write"]
}]
}'
Expand Down Expand Up @@ -246,7 +246,7 @@
"token_name": "Read/write token for all databases",
"permissions": [{
"resource_type": "db",
"resource_identifier": ["*"],
"resource_names": ["*"],
"actions": ["read","write"]
}]
}'
Expand Down Expand Up @@ -281,7 +281,7 @@
"token_name": "Read-only token for DATABASE_NAME",
"permissions": [{
"resource_type": "db",
"resource_identifier": ["DATABASE_NAME"],
"resource_names": ["DATABASE_NAME"],
"actions": ["read"]
}]
}'
Expand Down Expand Up @@ -316,7 +316,7 @@
"token_name": "Read-only token for DATABASE_NAME, DATABASE2_NAME",
"permissions": [{
"resource_type": "db",
"resource_identifier": ["DATABASE_NAME","DATABASE2_NAME"],
"resource_names": ["DATABASE_NAME","DATABASE2_NAME"],
"actions": ["read"]
}]
}'
Expand Down Expand Up @@ -352,7 +352,7 @@
"token_name": "Read/write token for DATABASE_NAME with 7d expiration",
"permissions": [{
"resource_type": "db",
"resource_identifier": ["DATABASE_NAME"],
"resource_names": ["DATABASE_NAME"],
"actions": ["read","write"]
}],
"expiry_secs": 604800
Expand Down Expand Up @@ -438,8 +438,8 @@

- `token_name`: a description of the token, unique within the instance
- `resource_type`: the resource type for the token, which is `system` for system tokens
- `resource_identifier`: an array of system resource names to grant permissions to
- The resource identifier field supports the `*` wildcard, which grants read or write
- `resource_names`: an array of system resource names to grant permissions to
- The `resource_names` field supports the `*` wildcard, which grants read or write
permissions to all system information resources.
- `permissions`: an array of token permission actions (only `"read"` for system tokens)
- `expiry_secs`: Specify the token expiration time in seconds.
Expand All @@ -458,7 +458,7 @@
"token_name": "System health token",
"permissions": [{
"resource_type": "system",
"resource_identifier": ["health"],
"resource_names": ["health"],
"actions": ["read"]
}],
"expiry_secs": 300000
Expand Down
Loading