Skip to content

Commit 41fafe5

Browse files
authored
Repo sync (#1071)
This is an automated pull request to sync changes between the public and private unified docs repos. To preserve continuity across repos, _do not squash_ this pull request.
2 parents a3f308a + f980ba7 commit 41fafe5

File tree

1 file changed

+9
-8
lines changed
  • content/terraform-enterprise/1.0.x/docs/enterprise/deploy/reference

1 file changed

+9
-8
lines changed

content/terraform-enterprise/1.0.x/docs/enterprise/deploy/reference/cli.mdx

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -164,13 +164,14 @@ Each specific run of the admin `usage-report` command generates the product usag
164164

165165
To send product usage reports to HashiCorp, visit the [**Licensing utilization reporting** page](https://portal.cloud.hashicorp.com/license-utilization/reports/create) and use the upload form.
166166

167-
## Manage admin API tokens
167+
## Manage System API tokens
168168

169-
Terraform Enterprise provides commands to manage authentication tokens for the Admin API, which allows programmatic access to administrative functions.
169+
Terraform Enterprise provides commands to manage authentication tokens for the System API, which allows programmatic access to administrative functions.
170+
Note that this is not equivalent to the Admin API which manages organization and workspace resources. The System API interacts with the TFE deployment and not the TFE application.
170171

171-
### Generate an admin API token
172+
### Generate a System API token
172173

173-
To create a new admin API token, use the `admin api-token generate` command with a required description that helps identify the token's purpose or owner:
174+
To create a new System API token, use the `admin api-token generate` command with a required description that helps identify the token's purpose or owner:
174175

175176
```shell-session
176177
$ tfectl admin api-token generate --description "Token description"
@@ -182,19 +183,19 @@ By default, tokens expire after 720 hours (30 days). You can specify a custom ti
182183
$ tfectl admin api-token generate --description "Token description" --ttl 2000
183184
```
184185

185-
### List admin API tokens
186+
### List System API tokens
186187

187-
To list all existing admin API tokens along with their metadata (excluding the actual token value), use:
188+
To list all existing System API tokens along with their metadata (excluding the actual token value), use:
188189

189190
```shell-session
190191
$ tfectl admin api-token list
191192
```
192193

193194
This command displays the token ID, creation date, expiration date, last used date, and description for each token. The output is ordered by creation date.
194195

195-
### Revoke an admin API token
196+
### Revoke a System API token
196197

197-
To revoke an admin API token, use the `admin api-token revoke` command with the token ID (obtained from the `list` command):
198+
To revoke a System API token, use the `admin api-token revoke` command with the token ID (obtained from the `list` command):
198199

199200
```shell-session
200201
$ tfectl admin api-token revoke --id "1"

0 commit comments

Comments
 (0)