Skip to main content

Pages

The system.page.* commands manage tenant custom homepage configurations and serve applicable published pages. See Custom Pages for the member-facing workflow.

List configurations​

system.page.list requires Pages access. Results include status, asset and applicability.

sl system page list --keyword shop --limit 20 --json
sl system page list --keyword shop --limit 20 --cursor '<nextCursor>' --json

keyword is optional, at most 200 characters. limit is 1–100, default 20. Reuse the opaque nextCursor with unchanged filters.

Create and edit​

system.page.create and system.page.update require Pages access and page-management permission. Discover the page asset UUID with system.studio.asset.list/get and subject UUIDs with organization/role commands. Use a Studio page asset, not a script asset or file UUID.

Create page.json:

{
"name": "Guest shop",
"description": "Shopping homepage",
"assetId": "<studio-page-asset-uuid>",
"scopes": [
{ "subjectType": "ROLE", "subjectId": "<role-uuid>" }
]
}
sl system page create --definition-file ./page.json --json
sl system page update --page-id '<page-uuid>' --definition-file ./page.json --json

Both accept exactly one of --definition-json or --definition-file.

FieldContract
nameRequired, 1–200 trimmed characters
descriptionOptional nullable string, at most 2000 characters
assetIdRequired Studio page asset UUID
scopesRequired complete array of 1–500 unique {subjectType,subjectId} entries
subjectTypeMEMBER, DEPARTMENT, ORGANIZATION or ROLE
subjectIdUUID of the selected subject

Create saves an inactive configuration. Update replaces all editable fields and the full scopes array; it preserves status. Neither command publishes the Studio asset. The initial administrator is always excluded from applicability, even through indirect role, department or organization membership.

Enable, disable and delete​

system.page.status.update and system.page.delete require page-management permission.

sl system page status update --page-id '<page-uuid>' --status active --json
sl system page status update --page-id '<page-uuid>' --status inactive --json
sl system page delete --page-id '<page-uuid>' --json

Status is exactly active or inactive. Deleting an active page is rejected. Delete keeps the Studio asset. An enabled configuration replaces the member homepage only when its asset is published. Among applicable active, published pages, newest created_at wins, then ID descending.

Resolve the current member's page​

system.page.home.get accepts no input and returns {page: ...} or {page: null}. It resolves the authenticated member's active, published homepage without granting management access.

sl system page home get --json

system.page.applicability.get checks an exact configuration for the current member and returns {pageId, applicable}. This check requires an active matching configuration but does not require a published asset; it is not proof that the page is ready to render.

sl system page applicability get --page-id '<page-uuid>' --json

Read runtime and execute actions​

system.page.runtime.get loads the applicable page's published runtime. system.page.action.execute executes an action declared in that published version, under the authenticated member's permissions.

sl system page runtime get --page-id '<page-uuid>' --json
sl system page action execute --page-id '<page-uuid>' --definition-file ./action.json --json

Example action.json:

{
"versionId": "<current-published-version-uuid>",
"actionName": "getCurrentUser",
"payload": {}
}

versionId must be the current published version UUID. actionName must be a declared action name, 1–64 characters, starting with a letter and followed by letters, digits or underscores. payload is an optional object, default {}. Re-read runtime after a new publication instead of submitting an old version. Draft source, caller-provided identities and management permissions are not substituted for the invoking member's permissions.