api/docs/account/authenticate.md

33 lines
886 B
Markdown
Raw Normal View History

# `/account/authenticate` - POST
Generates an authentication token for an account.
## HTTP Headers
| Header | Content |
|--------------|--------------------|
| Content-Type | `application/json` |
## Content - JSON
| Field | Description |
|----------|------------------------|
| username | The accounts username. |
| password | The accounts password. |
## Responses
### 200 - Success
The authentication was successfull.
__Content - JSON:__
| Field | Description |
|-------|------------------------|
| token | A unique access token. |
### 400 - Error: Bad Request
The request was malformed.
### 401 - Error: Unauthorized
The provided password was wrong.
### 403 - Error: Forbidden
Blocked for security reasons.
### 404 - Error: Not Found
The provided username was not found.
### 424 - Error: Failed Dependency
The account isn't verified yet.