Skip to content

users.md

Latest commit

 

History

History
22 lines (18 loc) · 934 Bytes

users.md

File metadata and controls

22 lines (18 loc) · 934 Bytes

Users

Add a new user

To add a new user, send a POST request to /user with the username and the plaintext password in HTTP standard authentication. It is strongly recommended to use HTTPS for this, otherwise your password will be leaked.

POST

/user

Response

If the user does not exist, the server responds with 201 Created and creates the user. If the user does exist, the server responds with 403 Forbidden. In case that the request doesn't provide any authentication, the response is 401 Unauthorized.

Remove a user

To remove a user, send a DELETE request to /user with HTTP standard authentication.

DELETE

/user

Response

In case the user exists and the authentication is correct, the user gets deleted and the server returns a 200 OK. When no authentication is given, the server returns 401 Unauthorized. When the authentication is incorrect, the return is 403 Forbidden.