Updates to agents

rkoron007 · rkoron007 · commit 0561befc8bd1 · 2025-09-19T11:14:38.000-07:00
diff --git a/content/terraform-docs-common/docs/cloud-docs/api-docs/agents.mdx b/content/terraform-docs-common/docs/cloud-docs/api-docs/agents.mdx
@@ -71,7 +71,7 @@ This endpoint supports pagination [with standard URL query parameters](/terrafor
 | `sort`                             | **Optional.** Allows sorting the returned agents pools. Valid values are `"name"` and `"created-at"`. Prepending a hyphen to the sort parameter will reverse the order (e.g. `"-name"`).                                                                                                                                    |
 | `page[number]`                     | **Optional.** If omitted, the endpoint will return the first page.                                                                                                                                                                                                                                                          |
 | `page[size]`                       | **Optional.** If omitted, the endpoint will return 20 agent pools per page.                                                                                                                                                                                                                                                 |
-| `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_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). |
 | `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). |
 
 
@@ -453,7 +453,7 @@ Properties without a default value are required.
 | `data.attributes.name`                            | string |         | The name of the agent pool, which can only include letters, numbers, `-`, and `_`. This will be used as an identifier and must be unique in the organization.                                                                                    |
 | `data.attributes.organization-scoped`             | bool   | true    | The scope of the agent pool. If true, all workspaces in the organization can use the agent pool.                                                                                          |
 | `data.relationships.allowed-workspaces.data.type` | string |         | Must be `"workspaces"`.                                                                                                                                                                    |
-| `data.relationships.allowed-workspaces.data.id`   | string |         | The ID of the workspace that has 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).  |
+| `data.relationships.allowed-workspaces.data.id`   | string |         | The ID of the workspace that has permission to use the agent pool. Refer to [Scoping Agent Pools to Specific Workspaces](/terraform/cloud-docs/agents#scope-an-agent-pool).  |
 | `data.relationships.allowed-projects.data.type`   | string |         | Must be `"projects"`. Refer to [Scoping Agent Pools to Specific Projects](/terraform/cloud-docs/agents#scope-an-agent-pool-to-specific-projects). |
 | `data.relationships.allowed-projects.data.id`     | string |         | The ID of the project that has permission to use the agent pool.  |
 | `data.relationships.excluded-workspaces.data.type`   | string |         | Must be `"workspaces"`.                                                                                                                                                                    |
@@ -595,7 +595,7 @@ Properties without a default value are required.
 | `data.attributes.name`                            | string | (previous value) | The name of the agent pool, which can only include letters, numbers, `-`, and `_`. This will be used as an identifier and must be unique in the organization.                                                                                    |
 | `data.attributes.organization-scoped`             | bool   | true             | The scope of the agent pool. If true, all workspaces in the organization can use the agent pool.                                                                                          |
 | `data.relationships.allowed-workspaces.data.type` | string |                  | Must be `"workspaces"`.                                                                                                                                                                   |
-| `data.relationships.allowed-workspaces.data.id`   | string |                  | The ID of the workspace that has 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). |
+| `data.relationships.allowed-workspaces.data.id`   | string |                  | The ID of the workspace that has permission to use the agent pool. Refer to [Scoping Agent Pools to Specific Workspaces](/terraform/cloud-docs/agents#scope-an-agent-pool). |
 | `data.relationships.allowed-projects.data.type`   | string |                  | Must be `"projects"`. Refer to [Scoping Agent Pools to Specific Projects](/terraform/cloud-docs/agents#scope-an-agent-pool-to-specific-projects). |
 | `data.relationships.allowed-projects.data.id`     | string |                  | The ID of the project that has permission to use the agent pool. |
 | `data.relationships.excluded-workspaces.data.type`   | string |         | Must be `"workspaces"`.                                                                                                                                                                    |
diff --git a/content/terraform-docs-common/docs/cloud-docs/api-docs/changelog.mdx b/content/terraform-docs-common/docs/cloud-docs/api-docs/changelog.mdx
@@ -340,7 +340,7 @@ This endpoint is exclusive to Terraform Enterprise, and not available in HCP Ter
 
 ### 2022-06-21
 * Updated [Admin Organizations](/terraform/enterprise/api-docs/admin/organizations) endpoints with new `workspace-limit` setting. This is available in Terraform Enterprise v202207-1 and later.
-* Updated [List Agent Pools](/terraform/cloud-docs/api-docs/agents#list-agent-pools) to accept a filter parameter `filter[allowed_workspaces][name]` so that agent pools can be filtered by name of an associated workspace. The given workspace must be allowed to use the agent pool. Refer to [Scoping Agent Pools to Specific Workspaces](/terraform/cloud-docs/agents#scope-an-agent-pool-to-specific-workspaces).
+* Updated [List Agent Pools](/terraform/cloud-docs/api-docs/agents#list-agent-pools) to accept a filter parameter `filter[allowed_workspaces][name]` so that agent pools can be filtered by name of an associated workspace. The given workspace must be allowed to use the agent pool. Refer to [Scoping Agent Pools to Specific Workspaces](/terraform/cloud-docs/agents#scope-an-agent-pool).
 * Added new `organization-scoped` attribute and `allowed-workspaces` relationship to the request/response body of the below endpoints. This is available in Terraform Enterprise v202207-1 and later.
   * [Show an Agent Pool](/terraform/cloud-docs/api-docs/agents#show-an-agent-pool)
   * [Create an Agent Pool](/terraform/cloud-docs/api-docs/agents#create-an-agent-pool)
diff --git a/content/terraform-docs-common/docs/cloud-docs/architectural-details/security-model.mdx b/content/terraform-docs-common/docs/cloud-docs/architectural-details/security-model.mdx
@@ -157,7 +157,7 @@ Workspaces may be configured to share their state with other workspaces within t
 
 ### Use separate agent pools for sensitive workspaces
 
-You can share [HCP Terraform Agents](/terraform/cloud-docs/agents) across all workspaces within an organization or [scope them to specific workspaces](/terraform/cloud-docs/agents#scope-an-agent-pool-to-specific-workspaces). If multiple workspaces share agent pools, a malicious actor in one of those workspaces could exfiltrate the agent’s API token, access private resources from the perspective of the agent, or modify the agent’s environment, potentially impacting other workspaces. For this reason, we recommend creating separate agent pools for sensitive workspaces and using the agent scoping setting to restrict which workspaces can target each agent pool.
+You can share [HCP Terraform Agents](/terraform/cloud-docs/agents) across all workspaces within an organization or [scope them to specific workspaces](/terraform/cloud-docs/agents#scope-an-agent-pool). If multiple workspaces share agent pools, a malicious actor in one of those workspaces could exfiltrate the agent’s API token, access private resources from the perspective of the agent, or modify the agent’s environment, potentially impacting other workspaces. For this reason, we recommend creating separate agent pools for sensitive workspaces and using the agent scoping setting to restrict which workspaces can target each agent pool.
 
 ### Treat Archivist URLs as secrets
 
