Mercurial > prosody-modules
view mod_auth_custom_http/README.markdown @ 4958:2735e29cf94b
mod_rest: Add some descriptive details to schema
author | Kim Alvefur <zash@zash.se> |
---|---|
date | Sun, 05 Jun 2022 21:56:22 +0200 |
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.