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

Register new permission(s)

POST/portal/v1/accounts/{accountSlug}/applications/{appSlug}/environments/{envSlug}/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

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

Requires capability env_permissions.manageDeveloper Console

Create, edit, and delete permissions. Granted through an administrator role in the Admin Workspace; a valid token without it is refused with 403.

Path Parameters

accountSlugstring Required

The Account's slug. An unknown one answers 404.

appSlugstring Required

The Application's slug within the Account.

envSlugstring Required

The Environment's slug within the Application.

Request body

application/json

permissionsPermissionItemDto[] Required

One or more permissions to register

Responses

application/json

  • dataPermissionResponseDto*

application/json

  • errorApiErrorBodyDto*

application/json

  • errorApiErrorBodyDto*

application/json

  • errorApiErrorBodyDto*

application/json

  • errorApiErrorBodyDto*

application/json

  • errorApiErrorBodyDto*

Errors

When the request can't be completed, the response body includes a stable error code you can branch on, and a correlation_id (also sent as the X-Correlation-Id header). Quote the correlation id when you contact support: it identifies the exact request in Canopy's logs.

403account.capability_requiredForbidden
When it happens

The signed-in user's administrator roles do not grant the capability this endpoint requires.

Remediation

Ask an account administrator to grant a role carrying the capability named in the Authentication section, then retry.

Returned object

PermissionResponseDtoView all properties on this resource
Request
curl -X POST "https://auth.canopy-io.com/portal/v1/accounts/value/applications/value/environments/value/permissions" \
  -H "Authorization: Bearer $CANOPY_TOKEN" \
  -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
POSTExplain a node-scoped authorization decision
GETGet a permission
PATCHUpdate permission metadata
DELETERemove a permission
GETGet where a permission is used
 Was this page helpful?

Tell us how we can improve this guide.

Canopy