Access operations
2 operations named access.*. Every one runs in a batch through apply_ops, dry_run_ops, the CLI or the admin.
Updated
| Operation | What it does | Permission | Confirmation |
|---|---|---|---|
| access.read | Read your own design-system levels on this site: the level of each area (palette, components, variants, themes, ...) and the role overrides that set them. | site.read | none |
| access.update | access.update with validated settings and revisioned undo. | site.admin | none |
access.read
Read your own design-system levels on this site: the level of each area (palette, components, variants, themes, ...) and the role overrides that set them. A designSystem.* operation is refused unless your level in its area allows it.
permission: site.readreads onlyclass: read
Example input
{}Input
The input is a record; see the schema below.
{
"type": "object",
"properties": {},
"additionalProperties": false
}Output
| Field | Type | Required | Notes |
|---|---|---|---|
| role | string | yes | One of "admin", "editor", "viewer", "client", "content". |
| levels | record of string | yes | |
| overrides | array of object | yes | |
| overrides[].role | string | yes | One of "editor", "client". |
| overrides[].area | string | yes | One of "palette", "semantic-colours", "font-families", "type-presets", "space", "radius", "borders", "shadow", "motion", "grid", "assets", "components", "variants", "themes", "import-export", "reset". |
| overrides[].level | string | yes | One of "none", "view", "edit", "pick", "switch-default", "export", "own-areas". |
Try it
yarn splash access.read '{}' --dry-runaccess.update
access.update with validated settings and revisioned undo.
permission: site.adminwrites: accessclass: transactionundo: yes
Example input
{
"role": "editor",
"area": "palette",
"level": "view"
}Input
| Field | Type | Required | Notes |
|---|---|---|---|
| role | string | yes | One of "editor", "client". |
| area | string | yes | One of "palette", "semantic-colours", "font-families", "type-presets", "space", "radius", "borders", "shadow", "motion", "grid", "assets", "components", "variants", "themes", "import-export", "reset". |
| level | string | yes | One of "none", "view", "edit", "pick", "switch-default", "export", "own-areas". |
Output
| Field | Type | Required | Notes |
|---|---|---|---|
| role | string | yes | One of "admin", "editor", "viewer", "client", "content". |
| levels | record of string | yes | |
| overrides | array of object | yes | |
| overrides[].role | string | yes | One of "editor", "client". |
| overrides[].area | string | yes | One of "palette", "semantic-colours", "font-families", "type-presets", "space", "radius", "borders", "shadow", "motion", "grid", "assets", "components", "variants", "themes", "import-export", "reset". |
| overrides[].level | string | yes | One of "none", "view", "edit", "pick", "switch-default", "export", "own-areas". |
Try it
yarn splash access.update '{"role":"editor","area":"palette","level":"view"}' --dry-runGenerated from the operation registry and the MCP tool catalogue (source aa7e3cc5740d2ba3).
Something wrong on this page? Write to docs@librettocms.com.