Skip to content
Kirby CMS
Kirby
4.8.0
Archived Docs
Guide
Reference
Cookbook
Quicktips
Screencasts
Glossary
Latest Version ↗
Reference
All pages
Guide
Reference
Cookbook
Plugin
Kosmos
Reference
Users
Close
Formatting text
KirbyText
Markdown
Templates
Field methods
Helpers
Panel
Blueprints
Fields
Sections
Blocks
Icons
Styling
Samples
Objects
$kirby
$site
$page
$pages
$file
$files
$user
$users
$block
$blocks
$layout
$layouts
$language
$languages
$pagination
$request
$session
All classes
Aliases
Router
Patterns
Response types
System
Config options
Urls
Roots
Requirements
Validators
Plugins
Extensions
Hooks
Core components
Panel UI
API
Authentication
Languages
Pages
Roles
Site
System
Translations
Users
Tools
A
Cookie
Data
Dir
Escape
F
Header
Html
I18n
Mime
QrCode
Query
Str
Tpl
Url
V
Xml
GET
/api/users
List users
POST
/api/users/
Create a user
GET
/api/users/:id
Retrieve a user
GET|POST
/api/users/:id/search
Search for users
PATCH
/api/users/:id
Update a user
DELETE
/api/users/:id
Delete a user
PATCH
/api/users/:id/email
Change the email
GET
/api/users/:id/files
List files
POST
/api/users/:id/files
Upload a new file
GET|POST
/api/users/:id/files/search
Search for user files
PATCH
/api/users/:id/files/sort
Sort files
GET
/api/users/:id/files/:filename
Retrieve a file
PATCH
/api/users/:id/files/:filename
Update file content
DELETE
/api/users/:id/files/:filename
Delete a file
PATCH
/api/users/:id/files/:filename/name
Rename a file
GET
/api/users/:id/files/:filename/sections/:name
Retrieve a file section
PATCH
/api/users/:id/language
Change the language
PATCH
/api/users/:id/name
Change the name
PATCH
/api/users/:id/password
Change the password
PATCH
/api/users/:id/role
Change the role
GET
/api/users/:id/sections/:name
Retrieve a user section
DELETE
/api/users/:id
Delete a user
users.delete