{"result":{"depiction_url":null,"edges":{"observes":{"objects":[{"created":"2026-09-09T13:47:46Z","object_id":{"id":1440,"is_a":["text","documentation","reference","notification"],"name":"doc_notification_logon_submit","title":"observe_logon_submit\/2","uri":"https:\/\/zotonic.com\/id\/1440"},"seq":1},{"created":"2026-09-09T13:47:46Z","object_id":{"id":1442,"is_a":["text","documentation","reference","notification"],"name":"doc_notification_request_context","title":"observe_request_context\/3","uri":"https:\/\/zotonic.com\/id\/1442"},"seq":2},{"created":"2026-09-09T13:47:46Z","object_id":{"id":1466,"is_a":["text","documentation","reference","notification"],"name":"doc_notification_admin_menu","title":"observe_admin_menu\/3","uri":"https:\/\/zotonic.com\/id\/1466"},"seq":3},{"created":"2026-09-09T13:47:46Z","object_id":{"id":1835,"is_a":["text","documentation","reference","notification"],"name":"doc_notification_auth_options_update","title":"observe_auth_options_update\/3","uri":"https:\/\/zotonic.com\/id\/1835"},"seq":4},{"created":"2026-09-09T13:47:46Z","object_id":{"id":2158,"is_a":["text","documentation","reference","notification"],"name":"doc_notification_m_config_update","title":"observe_m_config_update\/2","uri":"https:\/\/zotonic.com\/id\/2158"},"seq":5},{"created":"2026-09-09T13:47:46Z","object_id":{"id":2167,"is_a":["text","documentation","reference","notification"],"name":"doc_notification_auth_validated","title":"observe_auth_validated\/2","uri":"https:\/\/zotonic.com\/id\/2167"},"seq":6},{"created":"2026-09-09T13:47:46Z","object_id":{"id":2283,"is_a":["text","documentation","reference","notification"],"name":"doc_notification_auth_client_logon_user","title":"observe_auth_client_logon_user\/2","uri":"https:\/\/zotonic.com\/id\/2283"},"seq":7},{"created":"2026-09-09T13:47:46Z","object_id":{"id":2289,"is_a":["text","documentation","reference","notification"],"name":"doc_notification_auth_client_switch_user","title":"observe_auth_client_switch_user\/2","uri":"https:\/\/zotonic.com\/id\/2289"},"seq":8},{"created":"2026-09-09T13:47:46Z","object_id":{"id":2290,"is_a":["text","documentation","reference","notification"],"name":"doc_notification_logon_options","title":"observe_logon_options\/3","uri":"https:\/\/zotonic.com\/id\/2290"},"seq":9}],"predicate":{"id":2550,"is_a":["meta","predicate"],"name":"observes","title":{"_type":"trans","tr":{"en":"Observes"}},"uri":"https:\/\/zotonic.com\/id\/observes"}},"references":{"objects":[{"created":"2020-05-30T05:48:06Z","object_id":{"id":1536,"is_a":["text","documentation","developerguide"],"name":"doc_developerguide_access_control","title":"Access control","uri":"https:\/\/zotonic.com\/id\/1536"},"seq":1000000}],"predicate":{"id":332,"is_a":["meta","predicate"],"name":"references","title":{"_type":"trans","tr":{"en":"References"}},"uri":"https:\/\/zotonic.com\/id\/references"}},"subject":{"objects":[{"created":"2026-09-09T13:47:46Z","object_id":{"id":2555,"is_a":["categorization","keyword","keyword_information_type"],"name":"zotonic_topic_reference","title":"Reference","uri":"https:\/\/zotonic.com\/id\/2555"},"seq":1},{"created":"2026-09-09T13:47:46Z","object_id":{"id":2564,"is_a":["categorization","keyword","keyword_audience"],"name":"zotonic_topic_backend_developer","title":"Backend developer","uri":"https:\/\/zotonic.com\/id\/2564"},"seq":2},{"created":"2026-09-09T13:47:46Z","object_id":{"id":2589,"is_a":["categorization","keyword","keyword_domain"],"name":"zotonic_topic_identity_and_accounts","title":"Identity and accounts","uri":"https:\/\/zotonic.com\/id\/2589"},"seq":3},{"created":"2026-09-09T13:47:46Z","object_id":{"id":2590,"is_a":["categorization","keyword","keyword_domain"],"name":"zotonic_topic_authentication","title":"Authentication","uri":"https:\/\/zotonic.com\/id\/2590"},"seq":4},{"created":"2026-09-09T13:47:46Z","object_id":{"id":2635,"is_a":["categorization","keyword","keyword_architecture"],"name":"zotonic_topic_module","title":"Module","uri":"https:\/\/zotonic.com\/id\/2635"},"seq":5},{"created":"2026-09-09T13:47:46Z","object_id":{"id":2652,"is_a":["categorization","keyword","keyword_task"],"name":"zotonic_topic_authenticate","title":"Authenticate","uri":"https:\/\/zotonic.com\/id\/2652"},"seq":6},{"created":"2026-09-09T13:47:46Z","object_id":{"id":2685,"is_a":["categorization","keyword","keyword_quality"],"name":"zotonic_topic_security","title":"Security","uri":"https:\/\/zotonic.com\/id\/2685"},"seq":7}],"predicate":{"id":308,"is_a":["meta","predicate"],"name":"subject","title":{"_type":"trans","tr":{"en":"Keyword"}},"uri":"http:\/\/purl.org\/dc\/elements\/1.1\/subject"}}},"id":1306,"is_a":["text","documentation","reference","module"],"links":[{"rel":"self","target":"https:\/\/zotonic.com\/.zotonic\/websub\/topic\/1306"},{"rel":"hub","target":"https:\/\/zotonic.com\/.zotonic\/websub"}],"medium":null,"medium_url":null,"name":"doc_module_mod_authentication","page_url":{"en":"https:\/\/zotonic.com\/docs\/1306\/mod_authentication","x-default":"https:\/\/zotonic.com\/docs\/1306\/mod_authentication"},"preview_url":null,"resource":{"version":3320,"pivot_location_lat":null,"title":"mod_authentication","is_authoritative":true,"body":"

This module contains the main Zotonic authentication mechanism. It contains the logon and logoff controllers, and\nimplements the various hooks as described in the Access control<\/a> manual.<\/p>\n

Configuration keys:<\/p>\n
Key<\/th>Description<\/th><\/tr><\/thead>
mod_authentication.password_min_length<\/code><\/td>The minimum length of passwords. Defaults to 8; set this to an integer value.<\/td><\/tr>
mod_authentication.is_rememberme<\/code><\/td>Set this to 1<\/code> to check the remember me<\/em> checkbox per default.<\/td><\/tr>
mod_authentication.is_one_step_logon<\/code><\/td>Normally a two-step logon is used, first the username is requested, then the password is requested. In between the server checks the username and is able to show alternative authentication methods based on the username. Set this to 1<\/code> to show the username and password field at once, and disable the display of alternative authentication methods.<\/td><\/tr>
mod_authentication.is_signup_confirm<\/code><\/td>Set to 1<\/code> to force user confirmation of new accounts. This is useful when using 3rd party authentication services. If a new identity is found then a new account is automatically added. With this option set the user will be asked if they want to make a new account. This prevents duplicate accounts when using multiple authentication methods.<\/td><\/tr>
mod_authentication.reset_token_maxage<\/code><\/td>The maximum age of the emailed reset token in seconds. Defaults to 48 hours (172800 seconds). This must be an integer value.<\/td><\/tr>
mod_authentication.email_reminder_if_nomatch<\/code><\/td>On the password reset form, a user can enter their email address for receiving an email to reset their password. If a user enters an email address that is not connected to an active account then we do not send an email. If this option is set to 1<\/code> then an email is sent. This prevents the user waiting for an email, but enables sending emails to arbitrary addresses.<\/td><\/tr>
mod_authentication.auth_secret<\/code><\/td>The secret used to sign authentication cookies. This secret is automatically generated. Changing this secret will invalidate all authentication cookies.<\/td><\/tr>
mod_authentication.auth_anon_secret<\/code><\/td>The secret to sign authentication cookies for the anonymous user. This secret is automatically generated. Changing this secret will invalidate all authentication cookies for anonymous users.<\/td><\/tr>
mod_authentication.auth_user_secret<\/code><\/td>The secret to sign authentication cookies for the identified users if there is no database to store individual secrets.<\/td><\/tr>
mod_authentication.auth_autologon_secret<\/code><\/td>The secret to sign remember me<\/em> cookies. This secret is automatically generated. Changing this secret will invalidate all remember me<\/em> cookies for all users.<\/td><\/tr><\/tbody><\/table>\n

Related configurations:<\/p>\n
Key<\/th>Description<\/th><\/tr><\/thead>
site.password_force_different<\/code><\/td>Set to 1<\/code> to force a user picking a different password if they reset their password.<\/td><\/tr>
site.ip_allowlist<\/code><\/td>If the admin password is set to admin<\/code> then logon is only allowed from local IP addresses. This configuration overrules the ip_allowlist<\/code> global configuration and enables other IP addresses to login as admin<\/code> if the password is set to admin<\/code>.<\/td><\/tr><\/tbody><\/table>\n

Accepted Events<\/h2>\n

This module handles the following notifier callbacks:<\/p>\n

  • observe_admin_menu<\/code>: Contribute module entries to the admin menu tree.<\/li>
  • observe_auth_client_logon_user<\/code>: Send a request to the client to login a user using z_context:client_topic<\/code>.<\/li>
  • observe_auth_client_switch_user<\/code>: Send a request to the client to switch users using z_acl:sudo_user<\/code>.<\/li>
  • observe_auth_options_update<\/code>: Merge allowed external-auth options into the logon context for templates and handlers.<\/li>
  • observe_auth_validated<\/code>: Match validated external identities to local users and trigger signup or logon continuation.<\/li>
  • observe_logon_options<\/code>: Normalize and enrich logon options before authentication starts.<\/li>
  • observe_logon_submit<\/code>: Check username\/password against the identity tables using m_identity:check_username_pw<\/code>.<\/li>
  • observe_m_config_update<\/code>: Flush the auth_secret<\/code> depcache key when mod_authentication.auth_secret<\/code> changes, and flush the auth_anon_secret<\/code> depcache key when mod_authentication.auth_anon_secret<\/code> changes.<\/li>
  • observe_request_context<\/code>: Check for authentication cookies in the request using z_context:get<\/code>.<\/li>
  • observe_tick_1h<\/code>: Remove stale authentication and logon-history records in hourly maintenance.<\/li><\/ul>\n

    Delegate callbacks:<\/p>\n

    • event\/2<\/code> with postback<\/code> messages: close_all_sessions<\/code>.<\/li>
    • event\/2<\/code> with submit<\/code> messages: signup_confirm<\/code>.<\/li><\/ul>","slug":"mod_authentication","is_protected":false,"visible_for":0,"tz":"UTC","language":["en"],"doc_source_hash":"3e04511088b23f2bbc4791b401483a1af0e8ed192531b63b38ee102c7a94fa89","is_featured":false,"content_group_id":{"id":2551,"is_a":["meta","content_group"],"name":"content_group_imported_docs","title":"Imported documentation","uri":"https:\/\/zotonic.com\/id\/content_group_imported_docs"},"category_id":{"id":320,"is_a":["meta","category"],"name":"module","title":"Modules","uri":"https:\/\/test.zotonic.com\/id\/320"},"doc_source_path":"apps\/zotonic_mod_authentication\/src\/mod_authentication.erl","publication_start":"2023-01-30T19:23:58Z","github_url":"https:\/\/github.com\/zotonic\/zotonic\/blob\/master\/apps\/zotonic_mod_authentication\/src\/mod_authentication.erl","pivot_location_lng":null,"doc_source_kind":"module","name":"doc_module_mod_authentication","is_unfindable":false,"is_published":true,"pivot_geocode":null,"created":"2020-05-30T05:47:18Z","uri":null,"doc_status":"current","is_dependent":false,"erlang_app":"zotonic_mod_authentication","publication_end":"9999-06-01T00:00:00Z","modifier_id":{"id":1,"is_a":["person"],"name":"administrator","title":"Site Administrator","uri":"https:\/\/zotonic.com\/id\/1"},"privacy":0,"doc_source_commit":"85498256abd162b9bc082d43a90c995844fd4408\n","creator_id":{"id":336,"is_a":["person","robot"],"name":"gitbot","title":"Git","uri":"https:\/\/zotonic.com\/id\/336"},"modified":"2026-09-29T14:40:11Z","title_slug":"mod_authentication"},"uri":"https:\/\/zotonic.com\/id\/1306","uri_template":"https:\/\/zotonic.com\/id\/:id","websub":{"hub":"https:\/\/zotonic.com\/.zotonic\/websub","topic":"https:\/\/zotonic.com\/.zotonic\/websub\/topic\/1306"}},"status":"ok"}