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,69 @@
+# Authorization
+
+> This page is incomplete, stay tuned.
+
+## Check authorization
+
+### Code samples
+
+```shell
+# Example request using curl
+curl -X POST http://coder-server:8080/api/v2/authcheck \
+  -H 'Content-Type: application/json' \
+  -H 'Accept: application/json' \
+  -H 'Coder-Session-Token: API_KEY'
+```
+
+`POST /authcheck`
+
+> Body parameter
+
+```json
+{
+  "checks": {
+    "property1": {
+      "action": "create",
+      "object": {
+        "organization_id": "string",
+        "owner_id": "string",
+        "resource_id": "string",
+        "resource_type": "string"
+      }
+    },
+    "property2": {
+      "action": "create",
+      "object": {
+        "organization_id": "string",
+        "owner_id": "string",
+        "resource_id": "string",
+        "resource_type": "string"
+      }
+    }
+  }
+}
+```
+
+### Parameters
+
+| Name | In   | Type                                                                     | Required | Description           |
+| ---- | ---- | ------------------------------------------------------------------------ | -------- | --------------------- |
+| body | body | [codersdk.AuthorizationRequest](schemas.md#codersdkauthorizationrequest) | true     | Authorization request |
+
+### Example responses
+
+> 200 Response
+
+```json
+{
+  "property1": true,
+  "property2": true
+}
+```
+
+### Responses
+
+| Status | Meaning                                                 | Description | Schema                                                                     |
+| ------ | ------------------------------------------------------- | ----------- | -------------------------------------------------------------------------- |
+| 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 by means of one of the following methods: **CoderSessionToken**.