2.3 KiB
BaseAuth
Baseauth is a simple auth server, which is not meant to be usable in production environments.
API
The API runs uses HTTP and runs by default on port 8080.
All requests to endpoints are POST.
The Content-Type is always application/json, so all payloads are JSON strings.
endpoints
/register
Registers a new account.
Content / Payload
| Field | Description |
|---|---|
username |
The username of the account |
password |
The accounts' clear text password |
Responses
| Response | Description | |----------|–-----------------------------------------| | 200 | User created successfully | | 400 | Formal error in the request | | 409 | The requested username is already in use | | 500 | Internal server error |
/authenticate
Authenticates using an existing account.
Payload
| Field | Description |
|---|---|
username |
The username of the account |
password |
The accounts' clear text password |
Responses
| Response | Description | |----------|–---------------------------------------------------| | 200 | Authenticated successfully | | 400 | Formal error in the request | | 401 | Authentication failure (wrong password) | | 404 | There was no account found with the specified name | | 500 | Internal server error |
CLI
Arguments
| Argument | Description |
|---|---|
| `-D | --daemon` |
| `-d | --delete ` |
| `-w | --dir ` |