docs: applications and authorization (#5477)

* docs: Applications * WIP * WIP * WIP * Fix: consume * Fix: @Description * Fix * Fix: s/none//g * Fix: godoc nice * Fix: description * Fix: It * Fix: code sample trim empty line * More fixes * Fix: br
2026-09-24 15:04:27 +08:00 · 2022-12-21 15:37:30 +01:00
parent 935bb99bed
commit 2bbeff53f9
20 changed files with 830 additions and 231 deletions
@@ -0,0 +1,60 @@
+# Applications
+
+> This page is incomplete, stay tuned.
+
+## Redirect to URI with encrypted API key
+
+### Code samples
+
+```shell
+# Example request using curl
+curl -X GET http://coder-server:8080/api/v2/applications/auth-redirect \
+  -H 'Coder-Session-Token: API_KEY'
+```
+
+`GET /applications/auth-redirect`
+
+### Parameters
+
+| Name         | In    | Type   | Required | Description          |
+| ------------ | ----- | ------ | -------- | -------------------- |
+| redirect_uri | query | string | false    | Redirect destination |
+
+### Responses
+
+| Status | Meaning                                                                 | Description        | Schema |
+| ------ | ----------------------------------------------------------------------- | ------------------ | ------ |
+| 307    | [Temporary Redirect](https://tools.ietf.org/html/rfc7231#section-6.4.7) | Temporary Redirect |        |
+
+To perform this operation, you must be authenticated by means of one of the following methods: **CoderSessionToken**.
+
+## Get applications host
+
+### Code samples
+
+```shell
+# Example request using curl
+curl -X GET http://coder-server:8080/api/v2/applications/host \
+  -H 'Accept: application/json' \
+  -H 'Coder-Session-Token: API_KEY'
+```
+
+`GET /applications/host`
+
+### Example responses
+
+> 200 Response
+
+```json
+{
+  "host": "string"
+}
+```
+
+### Responses
+
+| Status | Meaning                                                 | Description | Schema                                                               |
+| ------ | ------------------------------------------------------- | ----------- | -------------------------------------------------------------------- |
+| 200    | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK          | [codersdk.GetAppHostResponse](schemas.md#codersdkgetapphostresponse) |
+
+To perform this operation, you must be authenticated by means of one of the following methods: **CoderSessionToken**.