Skip to content

Commit c70957b

Browse files
emlanctotrkoron007
authored andcommitted
Apply suggestions from code review
Co-authored-by: Rose M Koron <[email protected]>
1 parent 7cbc095 commit c70957b

File tree

3 files changed

+12
-7
lines changed

3 files changed

+12
-7
lines changed

content/terraform-docs-common/docs/cloud-docs/api-docs/organizations.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -433,7 +433,7 @@ Properties without a default value are required.
433433
| `data.attributes.default-execution-mode` | string | `remote` | Which [execution mode](/terraform/cloud-docs/workspaces/settings#execution-mode) to use by default. Valid values are `remote`, `local`, and `agent`. |
434434
| `data.attributes.default-agent-pool-id` | string | (previous value) | Required when `default-execution-mode` is set to `agent`. The ID of the agent pool belonging to the organization. Do _not_ specify this value if you set `execution-mode` to `remote` or `local`. |
435435
| `data.attributes.enforce-hyok` | boolean | false | Whether or not new workspaces within the organization are created with hold your own key enabled. Your organization must have a primary HYOK configuration before enabling `enforce-hyok`. Hold your own key is only available in HCP Terraform, [learn more](/terraform/cloud-docs/hold-your-own-key). |
436-
| `data.attributes.user-tokens-enabled` | boolean | true | Whether or not user tokens can access organization resources through the API. Defaults to true. |
436+
| `data.attributes.user-tokens-enabled` | boolean | true | Whether or not user tokens can access an organization's resources through the API. Defaults to `true`. |
437437

438438
### Sample Payload
439439

@@ -627,7 +627,7 @@ This PATCH endpoint requires a JSON object with the following properties as a re
627627
| `data.attributes.default-execution-mode` | string | `remote` | Which [execution mode](/terraform/cloud-docs/workspaces/settings#execution-mode) to use by default. Valid values are `remote`, `local`, and `agent`. |
628628
| `data.attributes.default-agent-pool-id` | string | (previous value) | Required when `default-execution-mode` is set to `agent`. The ID of the agent pool belonging to the organization. Do _not_ specify this value if you set `execution-mode` to `remote` or `local`. |
629629
| `data.attributes.enforce-hyok` | boolean | false | Whether or not new workspaces within the organization are created with hold your own key (HYOK) enabled. Your organization must have a primary HYOK configuration before enabling `enforce-hyok`. Hold your own key is only available in HCP Terraform, [learn more](/terraform/cloud-docs/hold-your-own-key). |
630-
| `data.attributes.user-tokens-enabled` | boolean | true | Whether or not user tokens can access organization resources through the API. Defaults to true. |
630+
| `data.attributes.user-tokens-enabled` | boolean | true | Whether or not user tokens can access an organization's resources through the API. Defaults to `true`. |
631631

632632
### Sample Payload
633633

content/terraform-docs-common/docs/cloud-docs/users-teams-organizations/api-tokens.mdx

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -16,20 +16,25 @@ Refer to [Team Token API](/terraform/cloud-docs/api-docs/team-tokens) and [Organ
1616

1717
API tokens may belong directly to a user. User tokens are the most flexible token type because they inherit permissions from the user they are associated with. For more information on user tokens and how to generate them, see the [Users](/terraform/cloud-docs/users-teams-organizations/users#tokens) documentation.
1818

19-
### Disabling user tokens for organizations
19+
### Disable user tokens for organizations
2020

21-
When user tokens are disabled for an organization, all user tokens will be blocked from accessing organization resources on the API. By default, user tokens are enabled for organizations.
21+
By default, user tokens are enabled for organizations. When your organization disables user tokens, the HCP Terraform API blocks user tokens from accessing organization resources.
2222

23+
To disable user tokens for your organization, perform the following steps:
2324
1. Sign in to [HCP Terraform](https://app.terraform.io/) or Terraform Enterprise, then navigate to the organization where you want to disable user tokens.
2425
1. Choose **Settings** from the sidebar, then **API tokens**.
2526
1. From the **User Tokens** tab, uncheck the **Allow members to access organization resources with their user tokens** setting.
2627
1. Click **Update settings**.
2728
1. In the confirmation modal, select **Disable**.
2829
1. User tokens are now disabled for this organization.
2930

30-
!> **Warning:** Use caution disabling user tokens for an organization. This could cause automation to fail if the automation is using user tokens to authenticate.
31+
If your organization has automations that authenticate using user tokens, disabling user tokens can cause those automations to fail.
3132

32-
-> **Note:** When user tokens are disabled for an organization, that organization should use **Github (OAuth)** to configure their VCS connections rather than **Github (App)**, as the latter relies on user tokens to authenticate to Github.
33+
<Note>
34+
35+
An organization that disables user tokens cannot connect to VCS using the [Github (App)](/terraform/cloud-docs/vcs/github-app), because it relies on user tokens to authenticate. Your organization can use [Github (OAuth) to configure their VCS connections](/terraform/cloud-docs/vcs/github) instead.
36+
37+
</Note>
3338

3439
## Team API Tokens
3540

content/terraform-docs-common/docs/cloud-docs/users-teams-organizations/users.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -193,7 +193,7 @@ To revoke a token, click the **trash can** next to it. That token will no longer
193193

194194
#### Tokens disabled
195195

196-
User tokens can be disabled at the organization level, for more information see the [API token](/terraform/cloud-docs/users-teams-organizations/api-tokens#user-api-tokens) documentation.
196+
User tokens can be disabled at the organization level, for more information refer to [User API tokens](/terraform/cloud-docs/users-teams-organizations/api-tokens#user-api-tokens).
197197

198198
### GitHub app OAuth token
199199

0 commit comments

Comments
 (0)