Evaluate authorization request

POST/authz/evaluate

Headers

Authorizationstring

Bearer <token>.

Returns

200OKEvalResponse

actionoptional string

allowedoptional boolean

environment_idoptional string

evaluation_msoptional integer

principaloptional string

reasonoptional string

resource_idoptional string

resource_typeoptional string

workspace_idoptional string

Errors

400Bad Request

POST Request

curl --request POST \
  --url 'https://api.hexelstudio.com/v1/authz/evaluate' \
  --header "Authorization: Bearer $ACCESS_TOKEN"

const res = await fetch("https://api.hexelstudio.com/v1/authz/evaluate", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.ACCESS_TOKEN}`,
  },
})
const data = await res.json()

import os
import requests

res = requests.post(
    "https://api.hexelstudio.com/v1/authz/evaluate",
    headers={"Authorization": f"Bearer {os.environ['ACCESS_TOKEN']}"},
)
data = res.json()

Response

{
  "action": "string",
  "allowed": true,
  "environment_id": "string",
  "evaluation_ms": 0,
  "principal": "string",
  "reason": "string",
  "resource_id": "string",
  "resource_type": "string",
  "workspace_id": "string"
}

{
  "key": "string"
}