Skip to content

Commit 52f4022

Browse files
Copilotjstirnaman
andauthored
fix(enterprise): change resource_identifier to resource_names in token API docs (#7064)
* Initial plan * fix(enterprise): change resource_identifier to resource_names in token API docs Agent-Logs-Url: https://github.com/influxdata/docs-v2/sessions/eb87b46a-7801-4d7e-b6d8-b0cb693bfcb6 Co-authored-by: jstirnaman <212227+jstirnaman@users.noreply.github.com> --------- Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: jstirnaman <212227+jstirnaman@users.noreply.github.com> Co-authored-by: Jason Stirnaman <jstirnaman@influxdata.com>
1 parent ded3dc9 commit 52f4022

File tree

1 file changed

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

1 file changed

+12
-12
lines changed

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

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ list_code_example: |
3131
"token_name": "Read-write for DATABASE1, DATABASE2",
3232
"permissions": [{
3333
"resource_type": "db",
34-
"resource_identifier": ["DATABASE1","DATABASE2"],
34+
"resource_names": ["DATABASE1","DATABASE2"],
3535
"actions": ["read","write"]
3636
}],
3737
"expiry_secs": 300000
@@ -130,8 +130,8 @@ In the request body, provide the following parameters:
130130

131131
- `token_name`: a description of the token, unique within the instance
132132
- `resource_type`: the resource type for the token, which is always `db`
133-
- `resource_identifier`: an array of database names to grant permissions to
134-
- The resource identifier field supports the `*` wildcard, which grants read or write
133+
- `resource_names`: an array of database names to grant permissions to
134+
- The `resource_names` field supports the `*` wildcard, which grants read or write
135135
permissions to all databases.
136136
- `permissions`: an array of token permission actions (`"read"`, `"write"`) for the database
137137
- `expiry_secs`: Specify the token expiration time in seconds.
@@ -149,7 +149,7 @@ The following example shows how to use the HTTP API to create a database token:
149149
"token_name": "Read-write for DATABASE1, DATABASE2",
150150
"permissions": [{
151151
"resource_type": "db",
152-
"resource_identifier": ["DATABASE1","DATABASE2"],
152+
"resource_names": ["DATABASE1","DATABASE2"],
153153
"actions": ["read","write"]
154154
}],
155155
"expiry_secs": 300000
@@ -211,7 +211,7 @@ curl \
211211
"token_name": "Read/write token for DATABASE_NAME",
212212
"permissions": [{
213213
"resource_type": "db",
214-
"resource_identifier": ["DATABASE_NAME"],
214+
"resource_names": ["DATABASE_NAME"],
215215
"actions": ["read","write"]
216216
}]
217217
}'
@@ -246,7 +246,7 @@ curl \
246246
"token_name": "Read/write token for all databases",
247247
"permissions": [{
248248
"resource_type": "db",
249-
"resource_identifier": ["*"],
249+
"resource_names": ["*"],
250250
"actions": ["read","write"]
251251
}]
252252
}'
@@ -281,7 +281,7 @@ curl \
281281
"token_name": "Read-only token for DATABASE_NAME",
282282
"permissions": [{
283283
"resource_type": "db",
284-
"resource_identifier": ["DATABASE_NAME"],
284+
"resource_names": ["DATABASE_NAME"],
285285
"actions": ["read"]
286286
}]
287287
}'
@@ -316,7 +316,7 @@ curl \
316316
"token_name": "Read-only token for DATABASE_NAME, DATABASE2_NAME",
317317
"permissions": [{
318318
"resource_type": "db",
319-
"resource_identifier": ["DATABASE_NAME","DATABASE2_NAME"],
319+
"resource_names": ["DATABASE_NAME","DATABASE2_NAME"],
320320
"actions": ["read"]
321321
}]
322322
}'
@@ -352,7 +352,7 @@ curl \
352352
"token_name": "Read/write token for DATABASE_NAME with 7d expiration",
353353
"permissions": [{
354354
"resource_type": "db",
355-
"resource_identifier": ["DATABASE_NAME"],
355+
"resource_names": ["DATABASE_NAME"],
356356
"actions": ["read","write"]
357357
}],
358358
"expiry_secs": 604800
@@ -438,8 +438,8 @@ In the request body, provide the following parameters:
438438

439439
- `token_name`: a description of the token, unique within the instance
440440
- `resource_type`: the resource type for the token, which is `system` for system tokens
441-
- `resource_identifier`: an array of system resource names to grant permissions to
442-
- The resource identifier field supports the `*` wildcard, which grants read or write
441+
- `resource_names`: an array of system resource names to grant permissions to
442+
- The `resource_names` field supports the `*` wildcard, which grants read or write
443443
permissions to all system information resources.
444444
- `permissions`: an array of token permission actions (only `"read"` for system tokens)
445445
- `expiry_secs`: Specify the token expiration time in seconds.
@@ -458,7 +458,7 @@ curl \
458458
"token_name": "System health token",
459459
"permissions": [{
460460
"resource_type": "system",
461-
"resource_identifier": ["health"],
461+
"resource_names": ["health"],
462462
"actions": ["read"]
463463
}],
464464
"expiry_secs": 300000

0 commit comments

Comments
 (0)