.. _external-auth-webservice:

.. index:: External Authentication; Webservice API

===============================================
External Authenication Webservice Specification
===============================================

Chatmongers Cloud can authenticate your users against a webservice which you maintain. This
document specifies the requirements of that service. The webservice can be either HTTP or
HTTPS, but HTTPS is recommended.

================ =============================================
HTTP Method
================ =============================================
GET              Supported
POST             Default
================ =============================================

================ =============================================
Parameters
================ =============================================
username         the username part of JID to authenticate
domain           the domain part of the JID to authenticate      
password         the password the user presented
secret           a string used to prevent unauthorized access
================ =============================================

================ =============================================
Response
================ =============================================
HTTP Code        200 (any other code denies access)
Content-type     application/json
Body             true if authorized; else false
================ =============================================