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
+12-5Lines changed: 12 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -134,7 +134,8 @@ curl \
134
134
"owners-team-saml-role-id": null,
135
135
"two-factor-conformant": false,
136
136
"assessments-enforced": false,
137
-
"default-execution-mode": "remote"
137
+
"default-execution-mode": "remote",
138
+
"user-tokens-enabled: true
138
139
},
139
140
"relationships": {
140
141
"default-agent-pool": {
@@ -223,7 +224,8 @@ curl \
223
224
"owners-team-saml-role-id": null,
224
225
"two-factor-conformant": false,
225
226
"assessments-enforced": false,
226
-
"default-execution-mode": "remote"
227
+
"default-execution-mode": "remote",
228
+
"user-tokens-enabled: true
227
229
},
228
230
"relationships": {
229
231
"default-agent-pool": {
@@ -358,7 +360,8 @@ curl \
358
360
"owners-team-saml-role-id": null,
359
361
"two-factor-conformant": false,
360
362
"assessments-enforced": false,
361
-
"default-execution-mode": "remote"
363
+
"default-execution-mode": "remote",
364
+
"user-tokens-enabled: true
362
365
},
363
366
"relationships": {
364
367
"default-agent-pool": {
@@ -430,6 +433,7 @@ Properties without a default value are required.
430
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`. |
431
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`. |
432
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. |
433
437
434
438
### Sample Payload
435
439
@@ -512,7 +516,8 @@ curl \
512
516
"owners-team-saml-role-id": null,
513
517
"two-factor-conformant": false,
514
518
"assessments-enforced": false,
515
-
"default-execution-mode": "remote"
519
+
"default-execution-mode": "remote",
520
+
"user-tokens-enabled: true
516
521
},
517
522
"relationships": {
518
523
"default-agent-pool": {
@@ -622,6 +627,7 @@ This PATCH endpoint requires a JSON object with the following properties as a re
622
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`. |
623
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`. |
624
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. |
0 commit comments