Permissions API

A permission is a single right, named by the resource it covers and the action it allows. This is the catalog those rights live in; roles reference them by ID. Browse what exists before you wire up a role.

The catalog

GET /permissions lists every permission. Each is a resource plus an action — for example ticket + read. Group the list with GET /permissions/categories, and read one entry with GET /permissions/{id}.

Create a permission

Most integrations only read this catalog, but you can extend it. Both resource and action are required; description is optional.

curl https://algapsa.com/api/v1/permissions \
  -H "X-API-Key: $ALGA_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "resource": "asset",
    "action": "decommission",
    "description": "Retire an asset and archive its history"
  }'

Where it is used

Before you change or delete a permission, check the blast radius with GET /permissions/{id}/roles, which lists every role that currently grants it.

Endpoints

Every endpoint links through to its full parameters, request and response schemas, and code samples.