Skip to content

The CMS
Docs
- Guide
- Reference
- Cookbook
- Quicktips
- Screencasts
- Glossary
- Archive
Resources
- Plugins
- Themes
- Newsletter
- Buzz
- License Hub
Community
Partners

Try
Buy

View all results ›

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
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
POST /api/users/:id/changes/discard

Discard unsaved changes for user
POST /api/users/:id/changes/publish

Publish unsaved changes for user
POST /api/users/:id/changes/save

Update unsaved changes for user
POST /api/users/:id/files/:filename/changes/discard

Discard unsaved changes for file
POST /api/users/:id/files/:filename/changes/publish

Publish unsaved changes for file
POST /api/users/:id/files/:filename/changes/save

Update unsaved changes for file

`PATCH` /api/users/:id/role

Change the role

users.changeRole

Patch parameters

Parameter	Type	Required	Description
`role`	`string`	`required`	The name of the new role 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

Edit this page on GitHub

Kirby

The CMS that adapts to any project. Made for developers, designers, creators and clients.

🇪🇺 Made in Europe

The CMS
Docs
- Guide
- Reference
- Cookbook
- Quicktips
- Screencasts
- Glossary
- Archive
Resources
- Plugins
- Themes
- Newsletter
- Buzz
- Pixels
- License Hub
Community
Kirby
- Security
- Privacy
- License
- Presskit
- Team
- Contact
With support of