Abilities
Every ability on this site, with its inputs, permissions and where it's available, generated from the running CMS.
On this page
Every ability on this site is listed below: what it takes, who may run it and where it's available. Names are the same everywhere: entries/create in the REST API and on the command line, entries.create as an MCP tool. Plugins add their own namespaces.
abilities
Every action this site supports for you, with input schemas.
account
The signed-in user.
Verify a code from the authenticator app and enable two-factor sign-in.
| Input | Type | Notes |
|---|---|---|
code required | string |
Turn off two-factor sign-in (needs your password).
| Input | Type | Notes |
|---|---|---|
password required | string |
Generate a TOTP secret. Confirm with account/two-factor-confirm.
Change name, email, locale, preferences, profile fields (data) or password (password changes need the current password).
| Input | Type | Notes |
|---|---|---|
name | string | |
email | string | |
locale | string | null | |
avatar | string | null | |
preferences | object | |
data | object | Profile fields (see users/fields). |
currentPassword | string | |
password | string |
admin
Every item of the sidebar or the home screen and an arrangement of them (the saved one, the given one, or the defaults when layout is null). Save with settings/update (namespace "admin", value "sidebar" or "dashboard").
| Input | Type | Notes |
|---|---|---|
of required | string | sidebar, or dashboard when letterncms/dashboard is on |
layout | object | null |
analytics
Views per page (with the entry it shows) or language for a period, most first. In visitors mode also visitors per page, entry page (where visits started), source (referring site or campaign; "Direct" when none), device, browser or operating system; in counts mode (the default) those answer {unavailable: "mode"}.
| Input | Type | Notes |
|---|---|---|
period | string | The last 7, 30 or 90 days, today included. One of 7d, 30d, 90d. Default '30d'. |
dimension required | string | One of pages, languages, entries, sources, devices, browsers, os. |
limit | integer | Default 10. |
Page views for a period, the same number for the period before (to compare) and one row per day. In visitors mode also visitors, views per visit, bounce rate and how many people are on the site now; in counts mode (the default, see `mode`) those are null.
| Input | Type | Notes |
|---|---|---|
period | string | The last 7, 30 or 90 days, today included. One of 7d, 30d, 90d. Default '30d'. |
assistant
One of your chats as shown in the panel, with calls waiting for approval.
| Input | Type | Notes |
|---|---|---|
id required | string |
Delete one of your chats.
| Input | Type | Notes |
|---|---|---|
id required | string |
Give one of your chats a short name from how it starts.
| Input | Type | Notes |
|---|---|---|
id required | string |
Your recent chats with the assistant, newest first.
| Input | Type | Notes |
|---|---|---|
limit | integer | |
offset | integer |
One context resource, for a chat that attaches it.
| Input | Type | Notes |
|---|---|---|
uri required | string |
What @ offers in a chat besides content: the context resources this person may read.
What / offers in a chat: the skills this person may use.
Whether the assistant is set up, the models to pick from and the default one.
audit
Recent changes made through abilities, newest first.
| Input | Type | Notes |
|---|---|---|
userId | string | |
page | integer | Default 1. |
perPage | integer | Default 50. |
The latest changes across the site in plain words: who did what to which entry, page or setting, and through which channel (admin, agent, API, CLI). Repeated saves of the same thing are folded into one item with a count.
| Input | Type | Notes |
|---|---|---|
limit | integer | Default 8. |
blocks
Convert Block Markdown (Markdown plus ::: directives for other blocks) into a block tree.
| Input | Type | Notes |
|---|---|---|
markdown required | string |
Search the Phosphor icon set for the Icon and Button blocks. Append -bold, -fill or -light to a name for other weights.
| Input | Type | Notes |
|---|---|---|
query | string | |
limit | integer | Default 120. |
Convert a block tree to Block Markdown.
| Input | Type | Notes |
|---|---|---|
blocks required | array |
Every block type (props, children, examples), every style property and variant, data sources for Repeat, and the schema of scripts (logic) and animations (motion). Compose pages from these.
brevo
Transactional email totals from Brevo for the last 7 days: requests, delivered, unique opens and clicks, bounces, blocked and spam reports. state is "ok", "inactive" (Brevo is not the mail transport), "no-key" or "error" (with a message). Cached for 10 minutes.
collab
Say you have an entry open (and whether you are editing); returns who else has it open and when it was last saved.
| Input | Type | Notes |
|---|---|---|
entryId required | string | |
editing | boolean | Default false. |
leave | boolean | Default false. |
collections
Delete a collection definition. Nonempty collections require deleteEntries true; entries, drafts and history are removed.
| Input | Type | Notes |
|---|---|---|
handle required | string | |
deleteEntries | boolean | Default false. |
A collection definition with its fields, the JSON schema entry data must follow, and its settings as fields.
| Input | Type | Notes |
|---|---|---|
handle required | string |
All content collections (content types) with their routes and structure.
Initial collection definition defaults and settings from the active plugins. Apply defaults before explicit creation settings; without the blocks plugin a new collection can contain fields only.
Each content collection you can view with how many entries it has in the default language, how many of them are drafts, and when one last changed.
Create or update a collection definition (fields, route, structure). Written to content/collections/<handle>.yaml.
| Input | Type | Notes |
|---|---|---|
handle required | string | |
createOnly | boolean | Reject an existing handle when creating a collection. Default false. |
definition required | object | title, singular, icon, driver (database|files), structure (list|tree|dated), default_view (table|grid|calendar), default_columns (null for automatic, [] for title only, or column IDs: uri, status, translations, author, published, updated, field:<handle>), route (e.g. /blog/{slug}), template, sort, body (the main content field handle; empty for fields only), section (default sidebar group), nav_order (default sidebar priority, lower first), fields[] |
comments
Comment on an entry, or reply to a thread with parentId. mentions are user ids (see comments/people); they get an email.
| Input | Type | Notes |
|---|---|---|
entryId required | string | |
body required | string | |
parentId | string | |
blockId | string | |
mentions | string[] | Default []. |
Delete your comment (moderators can delete any). Deleting a thread’s first comment deletes its replies.
| Input | Type | Notes |
|---|---|---|
id required | string |
Open threads that mention you or sit on entries you created, newest first.
| Input | Type | Notes |
|---|---|---|
limit | integer | Default 10. |
Comment threads on an entry (open threads first), with replies and mentions.
| Input | Type | Notes |
|---|---|---|
entryId required | string | |
resolved | boolean | Include resolved threads Default true. |
Admin users who can see an entry and can be @mentioned on it.
| Input | Type | Notes |
|---|---|---|
entryId required | string |
Mark a thread as resolved (or reopen it with resolved: false).
| Input | Type | Notes |
|---|---|---|
id required | string | |
resolved | boolean | Default true. |
Change the text of your comment.
| Input | Type | Notes |
|---|---|---|
id required | string | |
body required | string |
content
The most recently changed entries across collections you can view.
| Input | Type | Notes |
|---|---|---|
limit | integer | Default 10. |
Find entries across collections, ranking title and slug matches before content matches.
| Input | Type | Notes |
|---|---|---|
query required | string | |
collections | string[] | |
limit | integer | Default 10. |
design
Replace the site’s custom.css or custom.js (content/design). CSS is appended after everything else; JS loads as an ES module on every page and may register Alpine components (document.addEventListener("cms:alpine", (e) => e.detail.data("name", () => ({…})))) that elements use through logic.component.
| Input | Type | Notes |
|---|---|---|
css | string | |
js | string |
Download a Google Fonts family (latin, variable weights when available) into content/design/fonts so it is self-hosted, and add it to the design system. Then use it in a font token.
| Input | Type | Notes |
|---|---|---|
family required | string | |
italic | boolean | Default false. |
Add a .woff2 file (base64) to content/design/fonts and the design system.
| Input | Type | Notes |
|---|---|---|
family required | string | |
name | string | |
data required | string | |
weight | string | Default '400'. |
style | string | One of normal, italic. Default 'normal'. |
The site’s design system (content/design): tokens (use as token:group.name in styles), fonts, element styles, prose styles, button variants, page transition, breakpoints, custom CSS and JS, and the templates entries can use.
The stylesheet the site would get with these changes (the design/update input, plus css), without saving. For live previews.
| Input | Type | Notes |
|---|---|---|
tokens | object | |
dark | object | |
remove | string[] | |
rename | object | |
styles | object | |
prose | object | |
buttons | object | |
transition | object | |
css | string |
Change tokens (e.g. {"color.primary": "#0f766e"}; values may be CSS or {"min","max"} for fluid sizes), dark-mode values (null clears), renames, element styles, prose styles, button variants, fonts or the page transition. Sections you pass replace the stored ones. The site rebuilds.
| Input | Type | Notes |
|---|---|---|
tokens | object | path => value |
dark | object | path => dark-mode value |
remove | string[] | |
rename | object | old path => new path, within a group; references follow |
styles | object | Element styles: {"h1": {"fontSize": "token:text.5xl"}} |
prose | object | |
buttons | object | {"primary": {"base": {...}, "hover": {...}}} |
fonts | array | |
transition | object |
entries
Create an entry. `data` keys are the collection's field handles (see collections/get for the schema). Created as a draft unless status is "published".
| Input | Type | Notes |
|---|---|---|
collection required | string | |
title required | string | |
slug | string | |
data | object | Default []. |
locale | string | |
parentId | string | null | |
originId | string | null | For translations: the entry this one translates. |
status | string | One of draft, published. Default 'draft'. |
authorId | string | null | |
at | string | Publication time; requires status published. |
Permanently delete an entry. Children of tree entries move up one level.
| Input | Type | Notes |
|---|---|---|
id required | string | Entry id (ULID). |
expectedVersion | string |
Throw away unpublished changes of a published entry.
| Input | Type | Notes |
|---|---|---|
id required | string | Entry id (ULID). |
expectedVersion | string |
Copy an entry (as a draft).
| Input | Type | Notes |
|---|---|---|
id required | string | Entry id (ULID). |
expectedVersion | string |
One entry with its working copy (draft changes included) and data fields.
| Input | Type | Notes |
|---|---|---|
id required | string | Entry id (ULID). |
Query entries of a collection with filters, search, sorting and pagination.
| Input | Type | Notes |
|---|---|---|
collection required | string | |
locale | string | |
status | string | One of any, published, draft, live. Default 'any'. |
search | string | |
parentId | string | null | Tree collections: children of this entry; null for top level. |
sort | string | Field to sort by: title, slug, uri, status, locale, published_at, updated_at, created_at, position, author_id (by the author’s name) or a data field. Prefix with - for descending, e.g. -published_at. Empty values sort last. |
direction | string | Sort direction; overrides a - prefix on sort. One of asc, desc. |
fields | string[] | Data fields to include per entry under `values` (relations come with their titles and names). |
filters | object[] | |
page | integer | Default 1. |
perPage | integer | Default 25. |
Summaries for a list of entry ids (any collection you can view), in the given order.
| Input | Type | Notes |
|---|---|---|
ids required | string[] |
Move an entry immediately without publishing its draft. Moving published content requires publishing permission.
| Input | Type | Notes |
|---|---|---|
id required | string | Entry id (ULID). |
parentId required | string | null | |
position | integer | |
expectedVersion | string |
Publish an entry (applying its draft). Pass `at` to schedule.
| Input | Type | Notes |
|---|---|---|
id required | string | Entry id (ULID). |
at | string | |
expectedVersion | string |
Set the order of sibling entries (and move them under parentId for trees).
| Input | Type | Notes |
|---|---|---|
collection required | string | |
ids required | string[] | |
parentId | string | null | Default null. |
versions | object |
Restore an entry to a previous revision (as a draft for published entries).
| Input | Type | Notes |
|---|---|---|
revisionId required | string | Entry id (ULID). |
expectedVersion | string |
A single revision snapshot.
| Input | Type | Notes |
|---|---|---|
id required | string | Entry id (ULID). |
Revisions of an entry, newest first.
| Input | Type | Notes |
|---|---|---|
id required | string | Entry id (ULID). |
All entries of a tree collection (e.g. pages) nested by parent.
| Input | Type | Notes |
|---|---|---|
collection required | string | |
locale | string | |
fields | string[] | Data fields to include per entry under `values` (relations come with their titles and names). |
Take an entry offline (it becomes a draft).
| Input | Type | Notes |
|---|---|---|
id required | string | Entry id (ULID). |
expectedVersion | string |
Change an entry. `data` is merged into existing data. For published entries changes are saved as a draft until published (or pass publish: true).
| Input | Type | Notes |
|---|---|---|
id required | string | Entry id (ULID). |
title | string | |
slug | string | |
data | object | |
authorId | string | null | |
at | string | Publication time; requires publish true. |
publish | boolean | Default false. |
expectedVersion | string |
fields
Available field types and their options, for building blueprints.
fieldsets
Reusable field groups that collections can import.
Create or update a reusable fieldset (content/fieldsets/<handle>.yaml).
| Input | Type | Notes |
|---|---|---|
handle required | string | |
title required | string | |
fields required | object[] |
forms
Number of forms, unread submissions across all forms, submissions per day for the last 14 days (oldest first) and the latest submissions with a one-line summary.
| Input | Type | Notes |
|---|---|---|
limit | integer | Default 5. |
Delete a form definition (submissions are kept).
| Input | Type | Notes |
|---|---|---|
handle required | string |
All submissions of a form as CSV.
| Input | Type | Notes |
|---|---|---|
form required | string |
A form definition: fields (blocks) and settings.
| Input | Type | Notes |
|---|---|---|
handle required | string |
Forms with their field counts and new submissions.
Create or update a form. fields is a block tree using form/* blocks (form/text, form/email, form/textarea, form/select, form/radio, form/checkboxes, form/checkbox, form/consent, form/file, form/number, form/date, form/tel, form/url, form/hidden) and layout blocks; each field has props label, name, required.
| Input | Type | Notes |
|---|---|---|
handle required | string | |
title required | string | |
fields required | array | |
settings | object | |
locales | object | The form in other languages, per language code: {settings: {submit, success, confirmation_subject, confirmation_message}, fields: {<field name>: {label, help, placeholder, options, text}}}. Options keep their values: value|Label. |
Permanently delete submissions and their files.
| Input | Type | Notes |
|---|---|---|
ids required | string[] |
Mark a submission as read, spam or archived.
| Input | Type | Notes |
|---|---|---|
ids required | string[] | |
status required | string | One of new, read, spam, archived. |
Submissions of a form, newest first.
| Input | Type | Notes |
|---|---|---|
form required | string | |
status | string | One of all, new, read, spam, archived. Default 'all'. |
search | string | |
page | integer | Default 1. |
perPage | integer | Default 50. |
globals
Delete a global set and its values.
| Input | Type | Notes |
|---|---|---|
handle required | string |
A global set with its fields and values.
| Input | Type | Notes |
|---|---|---|
handle required | string | |
locale | string |
Global sets (site-wide values like footer or contact details), with when each last changed.
Create a global set or change its fields.
| Input | Type | Notes |
|---|---|---|
handle required | string | |
title required | string | |
icon | string | |
fields required | object[] |
Set values of a global set (merged into existing values).
| Input | Type | Notes |
|---|---|---|
handle required | string | |
values required | object | |
locale | string |
languages
The site’s languages with names, URL prefixes, direction and how many entries each has.
Set the site’s languages and the default one. Languages that still have entries cannot be removed.
| Input | Type | Notes |
|---|---|---|
default required | string | Language code, e.g. de or pt-BR |
languages required | string[] | |
prefixDefault | boolean | Also put the default language under a prefix (/en/…). |
Recently sent and failed emails.
| Input | Type | Notes |
|---|---|---|
limit | integer | Default 50. |
The transport email is sent with, whether it really delivers (log only does not), sent and failed counts for the last 7 days and the latest emails.
| Input | Type | Notes |
|---|---|---|
limit | integer | Default 5. |
Send a test message with the current email settings.
| Input | Type | Notes |
|---|---|---|
to required | string |
mcp
AI agents (MCP clients) signed in to your account with OAuth, when each was last active, and the latest changes made through MCP as you.
| Input | Type | Notes |
|---|---|---|
limit | integer | Default 5. |
media
Permanently delete a file and its image variants. Refused while something uses it, unless force is true.
| Input | Type | Notes |
|---|---|---|
id required | string | |
force | boolean | Default false. |
Add a file from a public URL or base64 data. Returns the new media item (use its id in media fields and image blocks).
| Input | Type | Notes |
|---|---|---|
url | string | |
filename | string | |
data | string | Base64 file content (with filename). |
alt | string | |
folder | string | Default ''. |
Browse the media library with search, filters and sorting.
| Input | Type | Notes |
|---|---|---|
search | string | |
kind | string | One of all, image, video, audio, pdf, file. Default 'all'. |
folder | string | null | |
sort | string | One of name, -name, size, -size, folder, -folder, created_at, -created_at, updated_at, -updated_at. Default '-created_at'. |
page | integer | Default 1. |
perPage | integer | Default 60. |
Details for media ids.
| Input | Type | Notes |
|---|---|---|
ids required | string[] |
Ids and /media/ URLs that point at nothing, records without a file, files without a record, and items nothing uses.
Change name, alt text, caption, folder or focal point (0–100 %).
| Input | Type | Notes |
|---|---|---|
id required | string | |
name | string | |
alt | string | |
caption | string | |
folder | string | |
focal | object |
navigation
packages
Put the key for a paid plugin in place, so the store offers it here.
| Input | Type | Notes |
|---|---|---|
key required | string |
A store's signed catalog as this site sees it: for each package what can be done with it here, and whether this site has access to it.
| Input | Type | Notes |
|---|---|---|
store | string | Default 'default'. |
refresh | boolean | Default false. |
Turn a module or plugin off. Its data is kept. Required modules cannot be turned off.
| Input | Type | Notes |
|---|---|---|
name required | string |
Turn a module or plugin on and run its install/upgrade steps.
| Input | Type | Notes |
|---|---|---|
name required | string |
Start installing a package from a store. Drive it with packages/job-step until it's done.
| Input | Type | Notes |
|---|---|---|
store | string | Default 'default'. |
package required | string | |
version | string | |
turnOn | boolean | Default true. |
One package's listing, its description cleaned on this site.
| Input | Type | Notes |
|---|---|---|
store | string | Default 'default'. |
package required | string |
Where an install stands.
| Input | Type | Notes |
|---|---|---|
id required | string |
Run the next step of an install. Each step is its own request, so nothing runs into a time limit.
| Input | Type | Notes |
|---|---|---|
id required | string |
Installed packages with status and their settings namespaces. core marks the modules the admin is made of; required ones cannot be disabled.
| Input | Type | Notes |
|---|---|---|
type | string | One of module, plugin, all. Default 'all'. |
What installing a package means here: dependencies in order, capabilities, access. Refused with the reason when it can't work.
| Input | Type | Notes |
|---|---|---|
store | string | Default 'default'. |
package required | string | |
version | string |
Put the previous version of a package back.
| Input | Type | Notes |
|---|---|---|
package required | string |
Read a store's name and root key fingerprint. Pinned only when confirm repeats that fingerprint. Code from a store runs with full access to this site.
| Input | Type | Notes |
|---|---|---|
url required | string | |
confirm | string |
Forget a store. What it installed stays.
| Input | Type | Notes |
|---|---|---|
id required | string |
The stores this site installs from, each with the fingerprint of its root key.
Run database migrations and install/upgrade steps for active packages.
Disable a plugin and remove its data (and its files when deleteFiles is true).
| Input | Type | Notes |
|---|---|---|
name required | string | |
deleteFiles | boolean | Default false. |
Turn automatic security updates on or off.
| Input | Type | Notes |
|---|---|---|
on required | boolean |
Fetch the signed release list and the store catalog now. Sends nothing but a User-Agent with the version.
Hold automatic security updates back for up to 14 days.
| Input | Type | Notes |
|---|---|---|
days | integer | Default 7. |
Go back to the release before this one, while it's still on disk.
Start updating the core to a version on offer. Drive it with packages/update-step.
| Input | Type | Notes |
|---|---|---|
version required | string |
Run the next step of the core update. After the switch, the answer says drive: the new release finishes through /_cms/update/tick.
Switch to a release someone uploaded into runtime/<version>/ by FTP.
| Input | Type | Notes |
|---|---|---|
version required | string |
Advance automatic security updates by one step.
The core update on offer and everything in its way, updates for store packages, and advisories about what's installed.
Upload a package zip in chunks of base64. The last chunk starts the install. Unsigned packages need a super admin and allowUnsigned.
| Input | Type | Notes |
|---|---|---|
id required | string | |
index required | integer | |
last | boolean | Default false. |
data required | string | |
sig | object | |
allowUnsigned | boolean | Default false. |
turnOn | boolean | Default true. |
patterns
Entries of the components collection (plus plugin patterns). Synced ones are components: instances update everywhere and take property values. Others are sections copied on insert. Create and change them with entries/create and entries/update in the "components" collection.
| Input | Type | Notes |
|---|---|---|
working | boolean | Default false. |
Create or replace an entry of the components collection by handle (slug). synced: true makes it a component. Saved as a draft of an existing one unless publish is true.
| Input | Type | Notes |
|---|---|---|
handle required | string | |
title required | string | |
description | string | |
category | string | |
synced | boolean | Default false. |
props | array | |
blocks required | array | |
publish | boolean | Default true. |
reading-time
How many words an entry has and how many minutes it takes to read.
| Input | Type | Notes |
|---|---|---|
id required | string |
The published entries that take longest to read, and the average reading time.
| Input | Type | Notes |
|---|---|---|
limit | integer | Default 5. |
redirects
URL redirects (content/redirects.yaml).
Replace the redirect list. Each: {from: "/old", to: "/new" or "https://…", status: 301|302}.
| Input | Type | Notes |
|---|---|---|
redirects required | object[] |
roles
Roles with their permissions, plus every known permission grouped. Change roles with settings/update (namespace "roles").
seo
On-page checks for search engines and AI answers (title, description, headings, alt text, answer-first, questions, links) with a score.
| Input | Type | Notes |
|---|---|---|
id required | string |
The on-page checks of seo/analyze across published pages (the 200 changed last; noindex pages left out): average score, how many pages score below 80, the most common issues and the lowest-scoring pages. Refreshed at most every 10 minutes.
| Input | Type | Notes |
|---|---|---|
limit | integer | Default 5. |
The clean Markdown version of a live page that AI crawlers receive.
| Input | Type | Notes |
|---|---|---|
id required | string |
settings
Fields and values for one settings namespace (secrets masked).
| Input | Type | Notes |
|---|---|---|
namespace required | string |
Settings namespaces registered by the core and plugins.
Save values for a settings namespace.
| Input | Type | Notes |
|---|---|---|
namespace required | string | |
values required | object |
site
Rebuild the static site (all pages). Work continues in the background; poll site/build-status.
Progress of the static build. Calling it also advances queued work.
Name, URL, timezone, locales and themes. Change them with settings/update (namespace "site").
URL that previews an entry's working copy (drafts included) for signed-in users.
| Input | Type | Notes |
|---|---|---|
id required | string |
system
CMS version, PHP, database, packages and pending upgrades.
templates
Entries of the templates collection: block documents that frame pages (header, Page content, footer…). `default` frames anything without its own, `404` renders missing pages. Edit them with entries/update; publishing rebuilds the site.
| Input | Type | Notes |
|---|---|---|
working | boolean | Default false. |
tokens
Create a personal access token. Scopes are ability patterns (e.g. "entries/*", "read" for all read-only abilities, "*" for everything). The token is shown once.
| Input | Type | Notes |
|---|---|---|
name required | string | |
scopes | string[] | Default ["*"]. |
expiresInDays | integer | null |
Personal access tokens for the REST API and MCP.
Delete one of your tokens.
| Input | Type | Notes |
|---|---|---|
id required | string |
translations
For each language, how many entries exist in it (as the original or a translation) out of all entries in content collections, as counts and a share. Counted at most every 10 minutes.
Start the version of an entry in another language, as a draft. translate: true translates the text with AI (when the assistant is set up); otherwise the content is copied for a person to translate.
| Input | Type | Notes |
|---|---|---|
id required | string | |
locale required | string | Language code, e.g. de or pt-BR |
translate | boolean | Default false. |
Every language version of an entry, with status and URL, plus the languages it is missing.
| Input | Type | Notes |
|---|---|---|
id required | string |
users
What someone holds beyond their roles (access names the gate on entries compares), who gave it and until when.
| Input | Type | Notes |
|---|---|---|
id required | string |
Add a user. Without a password, an invitation email with a set-password link is sent.
| Input | Type | Notes |
|---|---|---|
name required | string | |
email required | string | |
password | string | |
roles required | string[] | |
super | boolean | Default false. |
data | object | Profile fields (see users/fields). |
Remove a user. Their content stays.
| Input | Type | Notes |
|---|---|---|
id required | string |
The fields every user profile has beyond name and email (content/users.yaml), as stored and resolved.
Replace the fields of user profiles. Values of removed fields stay stored.
| Input | Type | Notes |
|---|---|---|
fields required | object[] |
One user.
| Input | Type | Notes |
|---|---|---|
id required | string |
Give someone an access name, optionally until a date. Entries gated on that name open for them.
| Input | Type | Notes |
|---|---|---|
id required | string | |
access required | string | |
until | string | null |
Email a user a link to set their password.
| Input | Type | Notes |
|---|---|---|
id required | string |
People with an account on this site: the team (who can open the admin) by default, or the site's visitors.
| Input | Type | Notes |
|---|---|---|
search | string | |
role | string | |
kind | string | One of team, visitors, all. Default 'team'. |
page | integer | Default 1. |
perPage | integer | Default 50. |
Safe person identities for authors and user relations, without account details.
| Input | Type | Notes |
|---|---|---|
search | string | |
ids | string[] | |
page | integer | Default 1. |
perPage | integer | Default 25. |
The people who signed in most recently (never signed in last), with their role names and how many users there are in all.
| Input | Type | Notes |
|---|---|---|
limit | integer | Default 6. |
Remove an access name from someone, whoever gave it.
| Input | Type | Notes |
|---|---|---|
id required | string | |
access required | string |
Change a user's name, email, roles or profile fields (data).
| Input | Type | Notes |
|---|---|---|
id required | string | |
name | string | |
email | string | |
roles | string[] | |
super | boolean | |
data | object | Profile fields (see users/fields), merged into the current values. |
suspended | boolean | A suspended account cannot sign in, and is signed out at its next request. |