Permissions

List the permissions and templates an operator can be given. Requires users:read.

TypeScript

const TOKEN = "hv_..."; // your API key
const headers = { Authorization: `Bearer ${TOKEN}` };

JavaScript

const TOKEN = "hv_..."; // your API key
const headers = { Authorization: `Bearer ${TOKEN}` };

Rust

let token = "hv_..."; // your API key

Go

const token = "hv_..." // your API key

cURL

# All examples assume $TOKEN is an API key (hv_...)
AUTH="Authorization: Bearer $TOKEN"

List permissions

GET /admin/permissions

Returns all available permission definitions and permission templates. When the Spaces feature flag is disabled, spaces-related permissions and template entries are excluded.

TypeScript

interface PermissionDef {
  key: string;
  name: string;
  description: string;
  category: string;
}

interface PermissionTemplate {
  key: string;
  label: string;
  permissions: string[];
}

interface PermissionsResponse {
  permissions: PermissionDef[];
  templates: PermissionTemplate[];
}

const response = await fetch("http://127.0.0.1:3000/admin/permissions", {
  headers,
});
const data: PermissionsResponse = await response.json();

JavaScript

const response = await fetch("http://127.0.0.1:3000/admin/permissions", {
  headers,
});
const data = await response.json();

Rust

let client = reqwest::Client::new();
let response = client
    .get("http://127.0.0.1:3000/admin/permissions")
    .bearer_auth(token)
    .send()
    .await?;
let data: serde_json::Value = response.json().await?;

Go

req, _ := http.NewRequest("GET", "http://127.0.0.1:3000/admin/permissions", nil)
req.Header.Set("Authorization", "Bearer "+token)
resp, err := http.DefaultClient.Do(req)
if err != nil {
  log.Fatal(err)
}
defer resp.Body.Close()

cURL

curl http://127.0.0.1:3000/admin/permissions -H "$AUTH"

Response: 200 OK

{
  "permissions": [
    {
      "key": "lexicons:create",
      "name": "Create Lexicons",
      "description": "Upload and register new lexicon schemas",
      "category": "Lexicons"
    }
  ],
  "templates": [
    {
      "key": "viewer",
      "label": "Viewer",
      "permissions": [
        "lexicons:read",
        "records:read",
        "script-variables:read",
        "scripts:read",
        "users:read",
        "api-keys:read",
        "backfill:read",
        "stats:read",
        "events:read",
        "metrics:read",
        "dead-letters:read"
      ]
    }
  ]
}

Templates are predefined permission bundles used when creating or updating operators. The order of a template’s permissions is not fixed. See the Permissions guide for the full list.