1. Docs
  2. API Reference
  3. Register new permission(s)

Register new permission(s)

POST/api/v1/permissions

Registers one or more custom permissions in the active Application's catalog for the current Environment, accepting an array under permissions (each with a required key, name, and category, plus an optional description). All created permissions are marked source: custom; a key that already exists in the Environment returns 409. Requires the rbac.manage_roles permission and emits a permission.created audit event per key.

Authentication

Bearer TokenAuthorization Option A

JWT access token. Never send alongside X-API-Key: a request carrying both is refused.

API KeyX-API-Key Option B

API key for management-tier access. Never send alongside an Authorization header: a request carrying both is refused.

Request body

application/json

permissionsPermissionItemDto[] Required

One or more permissions to register

Responses

application/json

  • dataPermissionResponseDto*

application/json

  • errorApiErrorBodyDto*

application/json

  • errorApiErrorBodyDto*

Returned object

PermissionResponseDtoView all properties on this resource
Request
curl -X POST "https://auth.canopy-io.com/api/v1/permissions" \
  -H "X-API-Key: $CANOPY_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "permissions": [
      {
        "key": "string",
        "name": "string",
        "description": "string",
        "category": "string"
      }
    ]
  }'
Response
{
  "data": {
    "id": "string",
    "application_id": "string",
    "key": "string",
    "name": "string",
    "description": "string",
    "category": "string",
    "source": "system",
    "created_at": "2026-04-20T12:00:00.000Z",
    "version": 0
  }
}
 Related endpoints
GETList permission catalog
GETGet a permission
PATCHUpdate permission metadata
DELETERemove a permission
GETGet where a permission is used
POSTEvaluate authorization
POSTBulk evaluate authorization
POSTExplain a node-scoped authorization decision
 Was this page helpful?

Tell us how we can improve this guide.

Canopy