File

mod_http_auth_check/README.markdown @ 5133:d7652471ae3e

mod_pubsub_text_interface: Improve error messages The internal error conditions are not always very clear, especially 'item-not-found' which actually means the _node_ does not exist.
author Kim Alvefur <zash@zash.se>
date Sun, 08 Jan 2023 17:53:14 +0100
parent 3448:c4db126a9f04
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