Mercurial > prosody-modules

comparison mod_auth_http/README.markdown @ 4594:1da63fe35ef3

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
mod_auth_http: Format README better
author Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
date Wed, 16 Jun 2021 17:32:43 +0200
parents df1e0465ff81
children
comparison
equal deleted inserted replaced
4593:b65a363d32d2 4594:1da63fe35ef3
56 The only mandatory methods that the service must implement are `check_password` 56 The only mandatory methods that the service must implement are `check_password`
57 and `user_exists`. Unsupported methods should return a HTTP status code 57 and `user_exists`. Unsupported methods should return a HTTP status code
58 of `501 Not Implemented`, but other error codes will also be handled by 58 of `501 Not Implemented`, but other error codes will also be handled by
59 Prosody. 59 Prosody.
60 60
61 ### register 61 Method HTTP method Success codes Error codes Response
62 62 -------- ---- --- ----------------- -----------------------------------------------------------------
63 **HTTP method:** 63 register POST 201 409 (user exists)
64 : POST 64 check\_password GET 200 A text string of `true` if the user exists, or `false` otherwise.
65 65 user\_exists GET 200 A text string of `true` if the user exists, or `false` otherwise.
66 **Success codes:** 66 set\_password POST 200, 201 or 204
67 : 201 67 remove\_user POST 200, 201 or 204
68
69 **Error codes:**
70 : 409 (user exists)
71
72 ### check_password
73
74 **HTTP method:**
75 : GET
76
77 **Success codes:**
78 : 200
79
80 **Response:**
81 : A text string of `true` if the user exists, or `false` otherwise.
82
83 ### user_exists
84
85 **HTTP method:**
86 : GET
87
88 **Success codes:**
89 : 200
90
91 **Response:**
92 : A text string of `true` if the user exists, or `false` otherwise.
93
94 ### set_password
95
96 **HTTP method:**
97 : POST
98
99 **Success codes:**
100 : 200, 201, or 204
101
102 ### remove_user
103
104 **HTTP method:**
105 : POST
106
107 **Success codes:**
108 : 200, 201 or 204
109 68
110 ## Examples 69 ## Examples
111 70
112 With the following configuration: 71 With the following configuration:
113 72