Skip to content

The CMS
Docs
- Guide
- Cookbook
- Reference
- Screencasts
- Glossary
Resources
- Plugins
- Themes
- Newsletter
- Buzz
Community

Try
Buy

View all results ›

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
- 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
- Str
- Tpl
- Url
- V
- Xml

new Auth()
$auth->createChallenge()

Creates an authentication challenge (one-time auth code)
$auth->csrf()

Returns the csrf token if it exists and if it is valid
$auth->csrfFromSession()

Returns either predefined csrf or the one from session
$auth->currentUserFromBasicAuth()

Returns the logged in user by checking for a basic authentication header with valid credentials
$auth->currentUserFromImpersonation()

Returns the currently impersonated user
$auth->currentUserFromSession()

Returns the logged in user by checking the current session and finding a valid valid user id in there
$auth->enabledChallenges()

Returns the list of enabled challenges in the configured order
$auth->flush()

Clears the cached user data after logout
$auth->impersonate()

Become any existing user or disable the current user
$auth->ipHash()

Returns the hashed ip of the visitor which is used to track invalid logins
$auth->isBlocked()

Check if logins are blocked for the current ip or email
$auth->log()

Read all tracked logins
$auth->logfile()

Returns the absolute path to the logins log
$auth->login()

Login a user by email and password
$auth->login2fa()

Login a user by email, password and auth challenge
$auth->logout()

Logout the current user
$auth->setUser()

Sets a user object as the current user in the cache
$auth->status()

Returns the authentication status object
$auth->track()

Tracks a login
$auth->type()

Returns the current authentication type
$auth->user()

Validates the currently logged in user
$auth->validatePassword()

Validates the user credentials and returns the user object on success; otherwise logs the failed attempt
$auth->verifyChallenge()

Verifies an authentication code that was requested with the createChallenge() method; if successful, the user is automatically logged in

$auth->flush()

Clears the cached user data after logout

kirby/src/Cms/Auth.php#L655

$auth->flush(): void

Parent class

Kirby\Cms\Auth

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