nerdcult
/
api
4
1
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs(api): updated the verify endpoint

This commit is contained in:
antifallobst 2023-10-08 13:31:23 +02:00
parent dc907bcb07
commit 2d12303bbc
Signed by: antifallobst
GPG Key ID: 2B4F402172791BAF
2 changed files with 39 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

27
docs/account/tokens.md
View File

@ -1,43 +1,62 @@
# `/account/tokens` - GET # `/account/tokens` - GET
Lists all active auth tokens for the account. Lists all active auth tokens for the account.
## HTTP Headers ## HTTP Headers
| Header | Content |
|---------------|--------------------| | Header | Content |
| Authorization | `Bearer {token}` | |---------------|------------------|
| Authorization | `Bearer {token}` |
## Responses ## Responses
### 200 - Success ### 200 - Success
__Content - JSON:__ __Content - JSON:__
| Field | Description | | Field | Description |
|--------|-------------------------------------------------------------------------------------------------| |--------|-------------------------------------------------------------------------------------------------|
| tokens | A list of (token, expiration date) pairs. The expiration date is given as a UTC UNIX timestamp. | | tokens | A list of (token, expiration date) pairs. The expiration date is given as a UTC UNIX timestamp. |
### 401 - Error: Unauthorized ### 401 - Error: Unauthorized
The provided auth token doesn't allow you to perform this operation. The provided auth token doesn't allow you to perform this operation.
### 403 - Error: Forbidden ### 403 - Error: Forbidden
Blocked for security reasons. Blocked for security reasons.
# `/account/tokens` - DELETE # `/account/tokens` - DELETE
Deletes a token of the authenticated account. Deletes a token of the authenticated account.
## HTTP Headers ## HTTP Headers
| Header | Content | | Header | Content |
|---------------|--------------------| |---------------|--------------------|
| Authorization | `Bearer {token}` | | Authorization | `Bearer {token}` |
| Content-Type | `application/json` | | Content-Type | `application/json` |
## Content - JSON ## Content - JSON
| Field | Description | | Field | Description |
|-------|-----------------------------------| |-------|-----------------------------------|
| token | The token that should be deleted. | | token | The token that should be deleted. |
## Responses ## Responses
### 200 - Success ### 200 - Success
The token was deleted. The token was deleted.
### 401 - Error: Unauthorized ### 401 - Error: Unauthorized
The provided auth token doesn't allow you to perform this operation. The provided auth token doesn't allow you to perform this operation.
### 403 - Error: Forbidden ### 403 - Error: Forbidden
Blocked for security reasons. Blocked for security reasons.
### 404 - Error: Not Found ### 404 - Error: Not Found
The token that should be deleted wasn't found. The token that should be deleted wasn't found.

17
docs/account/verify.md
View File

@ -1,22 +1,37 @@
# `/account/verify` - POST # `/account/verify` - POST
Verifies a requested account. Verifies a requested account.
## HTTP Headers ## HTTP Headers
| Header | Content | | Header | Content |
|--------------|--------------------| |--------------|--------------------|
| Content-Type | `application/json` | | Content-Type | `application/json` |
## Content - JSON ## Content - JSON
| Field | Description | | Field | Description |
|-------|--------------------------------------------------------------------------------| |-------|--------------------------------------------------------------------------------|
| token | The verification token you received via an email after requesting the account. | | token | The verification token you received via an email after requesting the account. |
## Responses ## Responses
### 200 - Success ### 200 - Success
The account was verified. You can login now.
The account was verified.
| Field | Description |
|-------|--------------------------------------------------|
| token | An authorization token for the verified account. |
### 400 - Error: Bad Request ### 400 - Error: Bad Request
The request was malformed. The request was malformed.
### 403 - Error: Forbidden ### 403 - Error: Forbidden
Blocked for security reasons. Blocked for security reasons.
### 404 - Error: Forbidden ### 404 - Error: Forbidden
The provided token is unknown. The provided token is unknown.