Skip to content

Commit cc6823a

Browse files
v0.1.564
[Bot] push changes from Files.com
1 parent 8f24e1a commit cc6823a

2 files changed

Lines changed: 34 additions & 1 deletion

File tree

README.md

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -180,6 +180,39 @@ For example, the following two paths are treated as equivalent after NFC normali
180180

181181
<div></div>
182182

183+
## Workspaces
184+
185+
A Workspace is a lightweight way to organize related resources inside a single Files.com Site.
186+
187+
Customers commonly group resources by project, department, client, or region. Workspaces provide a built-in structure for that grouping, so the UI can operate within a clear "workspace context" and admins can delegate management for a subset of resources without requiring full site-level isolation.
188+
189+
Every Site has an implicit Default workspace (ID `0`). Resources that are not explicitly assigned to a named workspace are considered part of the Default workspace.
190+
<div></div>
191+
192+
### SDK Support
193+
194+
We are still in the process of adding Workspaces support to each SDK. If you require Workspaces support right now, you need to use the REST API.
195+
<div></div>
196+
197+
### Using Workspaces with the REST API
198+
199+
To use Workspaces with the REST API, send the following request header:
200+
201+
```http
202+
X-Files-Workspace-Id: <workspace_id>
203+
```
204+
205+
This changes path mapping and "what you're looking at."
206+
207+
When the `X-Files-Workspace-Id` header is provided:
208+
209+
- List, show, update, and delete operations are constrained to that workspace for workspace-scoped models.
210+
- Create operations default `workspace_id` to the scoped workspace when not explicitly provided.
211+
- Attempts to provide a mismatching `workspace_id` are rejected with `not-authorized/insufficient-permission-for-params`.
212+
213+
This header only works for sitewide keys, or keys related to users with permissions to more than one workspace.
214+
<div></div>
215+
183216
## Foreign Language Support
184217

185218
The Files.com Terraform Provider will soon be updated to support localized responses by using a configuration

_VERSION

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
0.1.563
1+
0.1.564

0 commit comments

Comments
 (0)