Mercurial > prosody-modules
view mod_http_auth_check/README.markdown @ 5907:d194d1012fd3
Updating dox for mod_rest. Ideas expressed / clarified:
1) Making clear that mod_rest isn't to be installed under VirtualHosts AND as a component.
2) Understanding some of the implications of this choice:
A) Changes to user authentication
B) How it affects subdomains
3) More consistent use of domain names for clarity.
4) Using different heading sizes to show scope of section.
Essentially, I added all the tidbits I had to clarify in getting this to work in my
own example.
author | Ben Smith <bens@effortlessis.com> |
---|---|
date | Mon, 13 May 2024 13:25:13 -0700 |
parents | c4db126a9f04 |
children |
line wrap: on
line source
--- labels: summary: 'Test account credentials using HTTP' ... Introduction ------------ This module lets you test whether a set of credentials are valid, using Prosody's configured authentication mechanism. This is useful as an easy way to allow other (e.g. non-XMPP) applications to authenticate users using their XMPP credentials. Syntax ------ To test credentials, issue a simple GET request with HTTP basic auth: GET /auth_check HTTP/1.1 Authorization: Basic <base64(jid:password)> Prosody will return a 2xx code on success (user exists and credentials are correct), or 401 if the credentials are invalid. Any other code may be returned if there is a problem handling the request. ### Example usage Here follows some example usage using `curl`. curl http://prosody.local:5280/auth_check -u user@example.com:secr1t