doc: added documentation for the path
This commit is contained in:
parent
ca2f23915a
commit
d10d40522e
2 changed files with 45 additions and 2 deletions
43
README.md
43
README.md
|
@ -81,6 +81,49 @@ Invalid Auth:
|
|||
|
||||
Generic responses which is used unless otherwise specified above.
|
||||
|
||||
### POST /ldap/reset
|
||||
|
||||
```json
|
||||
{
|
||||
"user" : "[OPTIONAL] username looking for reset",
|
||||
"email" : "[OPTIONAL] email looking for reset"
|
||||
}
|
||||
```
|
||||
|
||||
All responses:
|
||||
```json
|
||||
{"result": "success"}
|
||||
```
|
||||
|
||||
### POST /ldap/reset/auth
|
||||
|
||||
```json
|
||||
{
|
||||
"auth" : "Auth key from teh email",
|
||||
"pass" : "Password the user chooses"
|
||||
}
|
||||
```
|
||||
|
||||
Early Errors:
|
||||
```json
|
||||
{"result": "error"}
|
||||
```
|
||||
|
||||
LDAP error:
|
||||
```json
|
||||
{"result": "error", "error": "ldap error"}
|
||||
```
|
||||
|
||||
Success:
|
||||
```json
|
||||
{"result": "success", "success": "Password set"}
|
||||
```
|
||||
|
||||
## Responses
|
||||
|
||||
Generic responses which is used unless otherwise specified above.
|
||||
|
||||
|
||||
### Success: HTTP 200
|
||||
```json
|
||||
{
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue