1. Docs
  2. API Reference
  3. Get a deny

Get a deny

GET/api/v1/denies/{id}

One deny: its target, the permissions it refuses, its node and the path to it, the roles it spares, its reason, and who created it when. A person is named under the same rule as the list. Requires deny.view.

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.

Path Parameters

idstring Required

Responses

application/json

  • dataDenyResponseDto*

application/json

  • errorApiErrorBodyDto*

application/json

  • errorApiErrorBodyDto*

application/json

  • errorApiErrorBodyDto*

application/json

  • errorApiErrorBodyDto*

Returned object

DenyResponseDtoView all properties on this resource
Request
curl -X GET "https://auth.canopy-io.com/api/v1/denies/value" \
  -H "X-API-Key: $CANOPY_API_KEY"
Response
{
  "data": {
    "id": "00000000-0000-0000-0000-000000000000",
    "target": {
      "type": "identity",
      "id": "00000000-0000-0000-0000-000000000000",
      "name": "string",
      "email": "string"
    },
    "permission_keys": [
      "documents.view"
    ],
    "node": {
      "id": "00000000-0000-0000-0000-000000000000",
      "name": "string",
      "path": [
        "string"
      ]
    },
    "exception_roles": [
      {
        "id": "00000000-0000-0000-0000-000000000000",
        "name": "string"
      }
    ],
    "reason": "string",
    "created_by": {
      "type": "user",
      "id": "00000000-0000-0000-0000-000000000000",
      "name": "string"
    },
    "created_at": "2026-04-20T12:00:00.000Z"
  }
}
 Related endpoints
GETList denies
POSTCreate a deny
POSTPreview a deny
DELETEDelete a deny
GETWhat a deny refuses today
 Was this page helpful?

Tell us how we can improve this guide.

Canopy