Skip to content

Commit 4f66230

Browse files
emlanctothelenjw
authored andcommitted
docs: organization API
1 parent df8cd96 commit 4f66230

File tree

1 file changed

+12
-5
lines changed

1 file changed

+12
-5
lines changed

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

Lines changed: 12 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -134,7 +134,8 @@ curl \
134134
"owners-team-saml-role-id": null,
135135
"two-factor-conformant": false,
136136
"assessments-enforced": false,
137-
"default-execution-mode": "remote"
137+
"default-execution-mode": "remote",
138+
"user-tokens-enabled: true
138139
},
139140
"relationships": {
140141
"default-agent-pool": {
@@ -223,7 +224,8 @@ curl \
223224
"owners-team-saml-role-id": null,
224225
"two-factor-conformant": false,
225226
"assessments-enforced": false,
226-
"default-execution-mode": "remote"
227+
"default-execution-mode": "remote",
228+
"user-tokens-enabled: true
227229
},
228230
"relationships": {
229231
"default-agent-pool": {
@@ -358,7 +360,8 @@ curl \
358360
"owners-team-saml-role-id": null,
359361
"two-factor-conformant": false,
360362
"assessments-enforced": false,
361-
"default-execution-mode": "remote"
363+
"default-execution-mode": "remote",
364+
"user-tokens-enabled: true
362365
},
363366
"relationships": {
364367
"default-agent-pool": {
@@ -430,6 +433,7 @@ Properties without a default value are required.
430433
| `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`. |
431434
| `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`. |
432435
| `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. |
433437

434438
### Sample Payload
435439

@@ -512,7 +516,8 @@ curl \
512516
"owners-team-saml-role-id": null,
513517
"two-factor-conformant": false,
514518
"assessments-enforced": false,
515-
"default-execution-mode": "remote"
519+
"default-execution-mode": "remote",
520+
"user-tokens-enabled: true
516521
},
517522
"relationships": {
518523
"default-agent-pool": {
@@ -622,6 +627,7 @@ This PATCH endpoint requires a JSON object with the following properties as a re
622627
| `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`. |
623628
| `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`. |
624629
| `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. |
625631

626632
### Sample Payload
627633

@@ -702,7 +708,8 @@ curl \
702708
"owners-team-saml-role-id": null,
703709
"two-factor-conformant": false,
704710
"assessments-enforced": false,
705-
"default-execution-mode": "remote"
711+
"default-execution-mode": "remote",
712+
"user-tokens-enabled: true
706713
},
707714
"relationships": {
708715
"default-agent-pool": {

0 commit comments

Comments
 (0)