Mercurial > prosody-modules
view mod_auth_custom_http/README.markdown @ 5123:09dd378748b8
mod_rest: Add some GET-mapped iq-queries to OpenAPI documentation
author | Kim Alvefur <zash@zash.se> |
---|---|
date | Sat, 31 Dec 2022 16:57:40 +0100 |
parents | f90cf59bee8e |
children |
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.