You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: content/terraform-docs-common/docs/cloud-docs/api-docs/organizations.mdx
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -433,7 +433,7 @@ Properties without a default value are required.
433
433
|`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`. |
434
434
|`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`. |
435
435
|`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`. |
437
437
438
438
### Sample Payload
439
439
@@ -627,7 +627,7 @@ This PATCH endpoint requires a JSON object with the following properties as a re
627
627
|`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`. |
628
628
|`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`. |
629
629
|`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`.|
Copy file name to clipboardExpand all lines: content/terraform-docs-common/docs/cloud-docs/users-teams-organizations/api-tokens.mdx
+9-4Lines changed: 9 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -16,20 +16,25 @@ Refer to [Team Token API](/terraform/cloud-docs/api-docs/team-tokens) and [Organ
16
16
17
17
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.
18
18
19
-
### Disabling user tokens for organizations
19
+
### Disable user tokens for organizations
20
20
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.
22
22
23
+
To disable user tokens for your organization, perform the following steps:
23
24
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.
24
25
1. Choose **Settings** from the sidebar, then **API tokens**.
25
26
1. From the **User Tokens** tab, uncheck the **Allow members to access organization resources with their user tokens** setting.
26
27
1. Click **Update settings**.
27
28
1. In the confirmation modal, select **Disable**.
28
29
1. User tokens are now disabled for this organization.
29
30
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.
31
32
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.
0 commit comments