mirror of https://github.com/coder/coder.git synced 2026-06-04 21:48:22 +00:00

Files

T

Marcin Tojek 2bbeff53f9 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

2022-12-21 15:37:30 +01:00

1.9 KiB

Raw Blame History

Authorization

This page is incomplete, stay tuned.

Check authorization

Code samples

# 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

{
  "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	true	Authorization request

Example responses

200 Response

{
  "property1": true,
  "property2": true
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	codersdk.AuthorizationResponse

To perform this operation, you must be authenticated by means of one of the following methods: CoderSessionToken.

1.9 KiB Raw Blame History