Skip to content

The CMS
Docs
- Guide
- Cookbook
- Reference
- Screencasts
- Glossary
Resources
- Newsletter
- Plugins
- Roadmap
- Releases
Community

Try
Buy

View all results ›

Text
- KirbyText
- Markdown
Templates
- Field methods
- Helpers
Panel
- Blueprints
- Presets
- Fields
- Sections
- Blocks
- Icons
- Samples
Objects
- $kirby
- $site
- $page
- $pages
- $file
- $files
- $user
- $users
- $blocks
- $layouts
- $language
- $languages
- $pagination
- $request
- $session
- All classes
- Aliases
Router
- Patterns
- Response types
System
- Options
- Urls
- Roots
- Validators
Plugins
API
- Authentication
- Languages
- Pages
- Roles
- Site
- System
- Translations
- Users
Tools
- A
- Cookie
- Data
- Dir
- Escape
- F
- Header
- Html
- I18n
- Mime
- Query
- Server
- Str
- Tpl
- Url
- V
- Xml

/api/users

List users
/api/users/

Create a user
/api/users/:id

Retrieve a user
/api/users/:id/search

Search for users
/api/users/:id

Update a user
/api/users/:id

Delete a user
/api/users/:id/email

Change the email
/api/users/:id/files

List files
/api/users/:id/files

Upload a new file
/api/users/:id/files/search

Search for user files
/api/users/:id/files/sort

Sort files
/api/users/:id/files/:filename

Retrieve a file
/api/users/:id/files/:filename

Update file content
/api/users/:id/files/:filename

Delete a file
/api/users/:id/files/:filename/name

Rename a file
/api/users/:id/files/:filename/sections/:name

Retrieve a file section
/api/users/:id/language

Change the language
/api/users/:id/name

Change the name
/api/users/:id/password

Change the password
/api/users/:id/role

Change the role
/api/users/:id/sections/:name

Retrieve a user section

/api/users/:id/email

Change the email

users.changeEmail

Patch parameters

Parameter	Type	Required	Description
`email`	`string`	`required`	The new email address for the user

Did you find an error? Help us improve our docs and edit this page on Github. Make sure to check out our styleguide →