docs: API users (#5620)

* docs: audit, deploymentconfig, files, parameters * Swagger comments in workspacebuilds.go * structs in workspacebuilds.go * workspaceagents: instance identity * workspaceagents.go in progress * workspaceagents.go in progress * Agents * workspacebuilds.go * /workspaces * templates.go, templateversions.go * templateversion.go in progress * cancel * templateversions * wip * Merge * x-apidocgen * NullTime hack not needed anymore * Fix: x-apidocgen * Members * Fixes * Fix * WIP * WIP * Users * Logout * User profile * Status suspend activate * User roles * User tokens * Keys * SSH key * All * Typo * Fix * Fix * Fix: LoginWithPasswordRequest
2025-07-23 21:32:07 +00:00 · 2023-01-11 14:08:04 +01:00
parent 84120767a7
commit 8e9cbdd71b
27 changed files with 4469 additions and 113 deletions
--- a/docs/api/authorization.md
+++ b/docs/api/authorization.md
@ -67,3 +67,50 @@ curl -X POST http://coder-server:8080/api/v2/authcheck \
 | 200    | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK          | [codersdk.AuthorizationResponse](schemas.md#codersdkauthorizationresponse) |

 To perform this operation, you must be authenticated. [Learn more](authentication.md).
+
+## Log in user
+
+### Code samples
+
+```shell
+# Example request using curl
+curl -X POST http://coder-server:8080/api/v2/users/login \
+  -H 'Content-Type: application/json' \
+  -H 'Accept: application/json' \
+  -H 'Coder-Session-Token: API_KEY'
+```
+
+`POST /users/login`
+
+> Body parameter
+
+```json
+{
+  "email": "user@example.com",
+  "password": "string"
+}
+```
+
+### Parameters
+
+| Name   | In   | Type                                                                             | Required | Description   |
+| ------ | ---- | -------------------------------------------------------------------------------- | -------- | ------------- |
+| `body` | body | [codersdk.LoginWithPasswordRequest](schemas.md#codersdkloginwithpasswordrequest) | true     | Login request |
+
+### Example responses
+
+> 201 Response
+
+```json
+{
+  "session_token": "string"
+}
+```
+
+### Responses
+
+| Status | Meaning                                                      | Description | Schema                                                                             |
+| ------ | ------------------------------------------------------------ | ----------- | ---------------------------------------------------------------------------------- |
+| 201    | [Created](https://tools.ietf.org/html/rfc7231#section-6.3.2) | Created     | [codersdk.LoginWithPasswordResponse](schemas.md#codersdkloginwithpasswordresponse) |
+
+To perform this operation, you must be authenticated. [Learn more](authentication.md).