Software /
code /
prosody-modules
File
mod_auth_custom_http/README.markdown @ 2868:f90cf59bee8e
mod_auth_custom_http: fix documentation config example
author | Senya <senya@kinetiksoft.com> |
---|---|
date | Thu, 01 Feb 2018 10:58:19 +0200 |
parent | 1934:6c569c481ffa |
line wrap: on
line source
--- summary: HTTP Authentication using custom JSON protocol ... Introduction ============ To authenticate users, this module does a `POST` request to a configured URL with a JSON payload. It is not async so requests block the server until answered. Configuration ============= ``` lua VirtualHost "example.com" authentication = "custom_http" auth_custom_http = { post_url = "http://api.example.com/auth"; } ``` Protocol ======== The JSON payload consists of an object with `username` and `password` members: {"username":"john","password":"secr1t"} The module expects the response body to be exactly `true` if the username and password are correct.