1. Docs
  2. API Reference
  3. What a deny refuses today

What a deny refuses today

GET/api/v1/denies/{id}/reach

Who an existing deny takes access from today, in the shape POST /denies/preview answers: the people and machine clients it refuses, per permission, those an exception role spares, and those another deny already refuses there. 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

Query Parameters

pagenumber Optional

Page number (1-based)

min 1

takenumber Optional

Items per page (1-100, default 20)

range 1–100

Responses

application/json

  • dataDenyPreviewResponseDto*

application/json

  • errorApiErrorBodyDto*

application/json

  • errorApiErrorBodyDto*

application/json

  • errorApiErrorBodyDto*

application/json

  • errorApiErrorBodyDto*

Returned object

DenyPreviewResponseDtoView all properties on this resource
Request
curl -X GET "https://auth.canopy-io.com/api/v1/denies/value/reach?page=0&take=0" \
  -H "X-API-Key: $CANOPY_API_KEY"
Response
{
  "data": {
    "people_named": false,
    "losing_count": 0,
    "kept_count": 0,
    "already_refused_count": 0,
    "permissions": [
      {
        "permission": "documents.view",
        "losing": 0
      }
    ],
    "people": {
      "items": [
        {
          "type": "identity",
          "id": "00000000-0000-0000-0000-000000000000",
          "name": "string",
          "email": "string",
          "loses": [
            "string"
          ]
        }
      ],
      "pagination": {
        "page": 0,
        "take": 0,
        "item_count": 0,
        "page_count": 0,
        "has_previous_page": false,
        "has_next_page": false
      }
    },
    "kept": [
      {
        "type": "identity",
        "id": "00000000-0000-0000-0000-000000000000",
        "name": "string",
        "email": "string",
        "exception_role": {
          "id": "00000000-0000-0000-0000-000000000000",
          "name": "string"
        }
      }
    ]
  }
}
 Related endpoints
GETList denies
POSTCreate a deny
POSTPreview a deny
GETGet a deny
DELETEDelete a deny
 Was this page helpful?

Tell us how we can improve this guide.

Canopy