diff options
| author | Owen Jacobson <owen@grimoire.ca> | 2025-08-24 04:08:20 -0400 |
|---|---|---|
| committer | Owen Jacobson <owen@grimoire.ca> | 2025-08-24 04:51:24 -0400 |
| commit | b922c4646aac28fd5f762604e54fd050e973ecd3 (patch) | |
| tree | ebc5c33f046fe13db54f290d32a7c841a9cc8fa4 /docs/api | |
| parent | ee9812bd35409abe9532b1d508e04c1dae63c941 (diff) | |
Stop returning a body from `POST /api/password`.
Diffstat (limited to 'docs/api')
| -rw-r--r-- | docs/api/authentication.md | 23 |
1 files changed, 3 insertions, 20 deletions
diff --git a/docs/api/authentication.md b/docs/api/authentication.md index 7694609..f1c0aea 100644 --- a/docs/api/authentication.md +++ b/docs/api/authentication.md @@ -121,29 +121,12 @@ The request must have the following fields: ### Success -This endpoint will respond with a status of -`200 Okay` when successful. The body of the response will be a JSON object describing the authenticated user: - -```json -{ - "id": "Uabcd1234", - "name": "Andrea" -} -``` - -The response will include the following fields: - -| Field | Type | Description | -| :----- | :----- | :----------------------------- | -| `id` | string | The authenticated user's ID. | -| `name` | string | The authenticated user's name. | +This endpoint will respond with a status of `204 No Content` when successful. -The response will include a `Set-Cookie` header for the -`identity` cookie, providing the client with a newly-minted identity token associated with the login identified in the request. This token's value must be kept confidential. All previously-created identity cookies will cease to be valid. +The response will include a `Set-Cookie` header for the `identity` cookie, providing the client with a newly-minted identity token associated with the login identified in the request. This token's value must be kept confidential. All previously-created identity cookies will cease to be valid. The cookie will expire if it is not used regularly. ### Authentication failure -This endpoint will respond with a status of `400 Bad Request` if the -`password` does not match the login's current password. +This endpoint will respond with a status of `400 Bad Request` if the `password` does not match the login's current password. |