Merge pull request #534 from hashicorp/tfe-release/1.1.x

TFE Release 1.1.x

Author: harshitchaudhary94

content/terraform-docs-common/data/cloud-docs-nav-data.json

@@ -95,7 +95,7 @@
         "path": "users-teams-organizations/api-tokens"
       },
       {
-  "title": "Single sign on",
+        "title": "Single sign on",
         "routes": [
           {
             "title": "Overview",

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

@@ -74,6 +74,7 @@ This endpoint supports pagination [with standard URL query parameters](/terrafor
 | `filter[allowed_workspaces][name]` | **Optional.** Filters agent pools to those associated with the given workspace. The workspace must have permission to use the agent pool. Refer to [Scoping Agent Pools to Specific Workspaces](/terraform/cloud-docs/agents#scope-an-agent-pool-to-specific-workspaces). |
 | `filter[allowed_stacks][name]`     | **Optional.** Filters agent pools to those associated with the given Stack. The Stack must have permission to use the agent pool. Only available in HCP Terraform, refer to [Scope agent pools](/terraform/cloud-docs/agents#scope-an-agent-pool) to learn more. |
 | `filter[allowed_projects][name]`   | **Optional.** Filters agent pools to those associated with the given project. The project must have permission to use the agent pool. Refer to [Scoping Agent Pools to Specific Projects](/terraform/cloud-docs/agents#scope-an-agent-pool-to-specific-projects). |
+| `filter[allowed_modules][name]`    | **Optional.** Filters agent pools to those configured to process jobs for the given registry module. Only available when the enterprise-testing feature is enabled.                                                                                                            |
 
 
 ### Response fields
@@ -168,6 +169,22 @@ curl \
               "type": "projects"
             }
           ]
+        },
+        "allowed-modules": {
+          "data": [
+            {
+              "id": "mod-Xf3VzW5zcRMMz12a",
+              "type": "registry-modules"
+            }
+          ]
+        },
+        "excluded-modules": {
+          "data": [
+            {
+              "id": "mod-YgBnkR89vQWer34b",
+              "type": "registry-modules"
+            }
+          ]
         }
       },
       "links": {
@@ -396,6 +413,22 @@ curl \
             "type": "projects"
           }
         ]
+      },
+      "allowed-modules": {
+        "data": [
+          {
+            "id": "mod-Xf3VzW5zcRMMz12a",
+            "type": "registry-modules"
+          }
+        ]
+      },
+      "excluded-modules": {
+        "data": [
+          {
+            "id": "mod-YgBnkR89vQWer34b",
+            "type": "registry-modules"
+          }
+        ]
       }
     },
     "links": {
@@ -510,6 +543,10 @@ Properties without a default value are required.
 | `data.relationships.excluded-workspaces.data.id`     | string |         | The ID of the workspace that is excluded from the scope of the agent pool.  |
 | `data.relationships.excluded-stacks.data.type`   | string |         | Must be `"stacks"`. Only available in HCP Terraform.                                                                                                                         |
 | `data.relationships.excluded-stacks.data.id`     | string |         | The ID of the Stack that is excluded from the scope of the agent pool. Only available in HCP Terraform.   |
+| `data.relationships.allowed-modules.data.type`     | string |         | Must be `"registry-modules"`. Only available when the enterprise-testing feature is enabled.                                                                                                       |
+| `data.relationships.allowed-modules.data.id`       | string |         | The ID of the registry module that the agent pool is allowed to process tests for. Only available when the enterprise-testing feature is enabled.                                                 |
+| `data.relationships.excluded-modules.data.type`    | string |         | Must be `"registry-modules"`. Only available when the enterprise-testing feature is enabled.                                                                                                       |
+| `data.relationships.excluded-modules.data.id`      | string |         | The ID of the registry module that the agent pool is excluded from processing tests for. Only available when the enterprise-testing feature is enabled.                                            |
 
 ### Sample Payload
 
@@ -561,6 +598,22 @@ Properties without a default value are required.
                 "type": "projects"
               }
             ]
+          },
+          "allowed-modules": {
+            "data": [
+              {
+                "id": "mod-Xf3VzW5zcRMMz12a",
+                "type": "registry-modules"
+              }
+            ]
+          },
+          "excluded-modules": {
+            "data": [
+              {
+                "id": "mod-YgBnkR89vQWer34b",
+                "type": "registry-modules"
+              }
+            ]
           }
         }
     }
@@ -647,6 +700,22 @@ curl \
             "type": "projects"
           }
         ]
+      },
+      "allowed-modules": {
+        "data": [
+          {
+            "id": "mod-Xf3VzW5zcRMMz12a",
+            "type": "registry-modules"
+          }
+        ]
+      },
+      "excluded-modules": {
+        "data": [
+          {
+            "id": "mod-YgBnkR89vQWer34b",
+            "type": "registry-modules"
+          }
+        ]
       }
     },
     "links": {
@@ -691,6 +760,10 @@ Properties without a default value are required.
 | `data.relationships.excluded-workspaces.data.id`     | string |         | The ID of the workspace that is excluded from the scope of the agent pool.  |
 | `data.relationships.excluded-stacks.data.type`   | string |         | Must be `"stacks"`. Only available in HCP Terraform.                                                                                                                                                                    |
 | `data.relationships.excluded-stacks.data.id`     | string |         | The ID of the Stack that is excluded from the scope of the agent pool. Only available in HCP Terraform.  |
+| `data.relationships.allowed-modules.data.type`     | string |         | Must be `"registry-modules"`. Only available when the enterprise-testing feature is enabled.                                                                                                       |
+| `data.relationships.allowed-modules.data.id`       | string |         | The ID of the registry module that the agent pool is allowed to process tests for. Only available when the enterprise-testing feature is enabled.                                                 |
+| `data.relationships.excluded-modules.data.type`    | string |         | Must be `"registry-modules"`. Only available when the enterprise-testing feature is enabled.                                                                                                       |
+| `data.relationships.excluded-modules.data.id`      | string |         | The ID of the registry module that the agent pool is excluded from processing tests for. Only available when the enterprise-testing feature is enabled.                                            |
 
 ### Sample Payload
 
@@ -742,6 +815,22 @@ Properties without a default value are required.
             "type": "projects"
           }
         ]
+      },
+      "allowed-modules": {
+        "data": [
+          {
+            "id": "mod-Xf3VzW5zcRMMz12a",
+            "type": "registry-modules"
+          }
+        ]
+      },
+      "excluded-modules": {
+        "data": [
+          {
+            "id": "mod-YgBnkR89vQWer34b",
+            "type": "registry-modules"
+          }
+        ]
       }
     }
   }
@@ -836,6 +925,22 @@ $ curl \
             "type": "projects"
           }
         ]
+      },
+      "allowed-modules": {
+        "data": [
+          {
+            "id": "mod-Xf3VzW5zcRMMz12a",
+            "type": "registry-modules"
+          }
+        ]
+      },
+      "excluded-modules": {
+        "data": [
+          {
+            "id": "mod-YgBnkR89vQWer34b",
+            "type": "registry-modules"
+          }
+        ]
       }
     },
     "links": {

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

@@ -16,10 +16,13 @@ description: >-
 
 # Applies API reference
 
-An apply represents the results of applying a Terraform workspace execution plan. <!-- BEGIN: TFC:only name:stacks-tfe --> If you are using a Stack and want to interact with Stack deployment runs, refer to [deployment runs](/terraform/cloud-docs/stacks/runs). <!-- END: TFC:only name:stacks-tfe -->
+An apply represents the results of applying a Terraform workspace execution plan. <!-- BEGIN: TFC:only name:stacks-tfe --> 
+If you are using a Stack and want to interact with Stack deployment runs, refer to [deployment runs](/terraform/cloud-docs/stacks/runs). <!-- END: TFC:only name:stacks-tfe -->
 
 ## Attributes
 
+The `/applies` endpoint has the following attributes. 
+
 ### Apply States
 
 You'll find the apply state in `data.attributes.status`, as one of the following values.

content/terraform-docs-common/docs/cloud-docs/api-docs/change-requests.mdx

@@ -319,3 +319,7 @@ $ curl \
   }
 }
 ```
+
+<!-- BEGIN: TFEnterprise:only name:explorer -->
+@include 'beta/explorer-limitations.mdx'
+<!-- END: TFEnterprise:only name:explorer -->

content/terraform-docs-common/docs/cloud-docs/api-docs/configuration-versions.mdx

@@ -40,16 +40,18 @@ description: >-
 
 # Configuration versions API reference
 
--> **Note:** Before working with the runs or configuration versions APIs, read the [API-driven run workflow](/terraform/cloud-docs/workspaces/run/api) page, which includes both a full overview of this workflow and a walkthrough of a simple implementation of it.
+Before working with the runs or configuration versions APIs, read the [API-driven run workflow](/terraform/cloud-docs/workspaces/run/api) page. The page provides a full overview of the workflow and walks through a simplified implementation.
 
-A configuration version (`configuration-version`) is a resource used to reference the uploaded configuration files on a workspace. It is associated with the run to use the uploaded configuration files for performing the plan and apply.
+Use the `configuration-version` endpoint to reference uploaded configuration files on a workspace. It is associated with the run to use the uploaded configuration files for performing the plan and apply.
 
 You need read runs permission to list and view configuration versions for a workspace, and you need queue plans permission to create new configuration versions. Refer to the [permissions](/terraform/cloud-docs/users-teams-organizations/permissions/workspace) documentation for more details.
 
 [permissions-citation]: #intentionally-unused---keep-for-maintainers
 
 ## Attributes
 
+The `/configuration-version` endpoint has the following attributes.
+
 ### Configuration Version States
 
 The configuration version state is found in `data.attributes.status`, and you can reference the following list of possible states.

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

@@ -888,3 +888,7 @@ all_checks_succeeded,checks_errored,checks_failed,checks_passed,checks_unknown,c
 "true","0","0","0","0","","run-rdoEKh2Gy3K6SbCZ","planned_and_finished","false","ws-j2sAeWRxou1b5HYf","0","","acme-corp","prj-V61QLE8tvs4NvVZG","Default Project","0","","0","0","1.5.7","","2023-10-17T21:56:45+00:00","candy distribution service","1.5.7","2023-12-13T15:48:16+00:00"
 "true","0","0","0","0","2023-08-18T16:24:59+00:00","run-9MmJaoQTvDCh5wUa","applied","true","ws-igUVNQSYVXRkhYuo","0","","acme-corp","prj-uU2xNqGeG86U9WgT","web","0","","3","3","1.4.5","acmecorp/api","2023-04-25T17:09:14+00:00","api-service","1.4.5","2023-12-13T15:29:03+00:00"
 ```
+
+<!-- BEGIN: TFEnterprise:only name:explorer -->
+@include 'beta/explorer-limitations.mdx'
+<!-- END: TFEnterprise:only name:explorer -->

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

@@ -125,9 +125,9 @@ The following entitlements are available:
 - `module-deprecations` - Allows an organization to mark a module version from the Private Registry as deprecated.
 - `module-revocations` - Allows an organization to mark a deprecated module version from the Private Registry as revoked.
 - `operations` — Allows an organization to perform runs within HCP Terraform. Affects the [runs][], [plans][], and [applies][] endpoints.
-- `policy-enforcement` — Allows an organization to use [Sentinel][]. Affects the [policies][], [policy sets][], and [policy checks][] endpoints.
+- `policy-enforcement` — Allows an organization to use [Sentinel](/terraform/cloud-docs/policy-enforcement/define-policies/custom-sentinel). Affects the [policies][], [policy sets][], and [policy checks][] endpoints.
 - `private-module-registry` — Allows an organization to publish and use modules with the [private module registry][]. Affects the [registry modules][] endpoints.
-- `private-policy-agents` - Allows an organization to ensure that HTTP enabled [Sentinel][] and OPA [policies][] can communicate with isolated, private, or on-premises infrastructure.
+- `private-policy-agents` - Allows an organization to ensure that HTTP enabled [Sentinel](/terraform/cloud-docs/policy-enforcement/define-policies/custom-sentinel) and OPA [policies][] can communicate with isolated, private, or on-premises infrastructure.
 <!-- BEGIN: TFC:only name:premium -->
 - `private-run-tasks` - Allows an organization to ensure that [run tasks](/terraform/cloud-docs/workspaces/settings/run-tasks) can communicate with isolated, private, or on-premises infrastructure.
 - `private-vcs` - Allows a self-hosted HCP Terraform agent to [connect to a private VCS provider](/terraform/cloud-docs/vcs/private) without having to expose that provider to the public internet.

content/terraform-docs-common/docs/cloud-docs/api-docs/oauth-clients.mdx

@@ -59,10 +59,11 @@ This endpoint allows you to list VCS connections between an organization and a V
 
 This endpoint supports pagination [with standard URL query parameters](/terraform/cloud-docs/api-docs#query-parameters). Remember to percent-encode `[` as `%5B` and `]` as `%5D` if your tooling doesn't automatically encode URLs.  If neither pagination query parameters are provided, the endpoint will not be paginated and will return all results.
 
-| Parameter      | Description                                                                   |
-| -------------- | ----------------------------------------------------------------------------- |
-| `page[number]` | **Optional.** If omitted, the endpoint will return the first page.            |
-| `page[size]`   | **Optional.** If omitted, the endpoint will return 20 oauth clients per page. |
+| Parameter                  | Description                                                                                                                                                       |
+| --------------             | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `page[number]`             | **Optional.** If omitted, the endpoint will return the first page.                                                                                                |
+| `page[size]`               | **Optional.** If omitted, the endpoint will return 20 oauth clients per page.                                                                                     |
+| `show_affected_workspaces` | **Optional.** If set to `true`, the endpoint will return names of up to 25 affected workspaces and the total number of affected workspaces for each oauth client. |
 
 ### Sample Request
 
@@ -71,7 +72,7 @@ curl \
   --header "Authorization: Bearer $TOKEN" \
   --header "Content-Type: application/vnd.api+json" \
   --request GET \
-  https://app.terraform.io/api/v2/organizations/my-organization/oauth-clients
+  https://app.terraform.io/api/v2/organizations/my-organization/oauth-clients?show_affected_workspaces=true
 ```
 
 ### Sample Response
@@ -93,7 +94,12 @@ curl \
         "api-url": "https://api.github.com",
         "key": null,
         "rsa-public-key": null,
-        "organization-scoped": false
+        "organization-scoped": false,
+        "affected-workspaces": [
+            "ws-1",
+            "ws-2"
+        ],
+        "affected-workspaces-count": 2
       },
       "relationships": {
         "organization": {
@@ -144,14 +150,20 @@ curl \
 | [200][] | [JSON API document][] (`type: "oauth-clients"`) | Success                                                        |
 | [404][] | [JSON API error object][]                       | OAuth Client not found, or user unauthorized to perform action |
 
+### Query Parameters
+
+| Parameter                  | Description                                                                                                                                 |
+| --------------             | ------------------------------------------------------------------------------------------------------------------------------------------- |
+| `show_affected_workspaces` | **Optional.** If set to `true`, the endpoint will return names of up to 25 affected workspaces and the total number of affected workspaces. |
+
 ### Sample Request
 
 ```shell
 curl \
   --header "Authorization: Bearer $TOKEN" \
   --header "Content-Type: application/vnd.api+json" \
   --request GET \
-  https://app.terraform.io/api/v2/oauth-clients/oc-XKFwG6ggfA9n7t1K
+  https://app.terraform.io/api/v2/oauth-clients/oc-XKFwG6ggfA9n7t1K?show_affected_workspaces=true
 ```
 
 ### Sample Response
@@ -172,7 +184,12 @@ curl \
       "api-url": "https://api.github.com",
       "key": null,
       "rsa-public-key": null,
-      "organization-scoped": false
+      "organization-scoped": false,
+      "affected-workspaces": [
+          "ws-1",
+          "ws-2"
+      ],
+      "affected-workspaces-count": 2
     },
     "relationships": {
       "organization": {