1. Docs
  2. API Reference
  3. DenyPreviewResponseDto

DenyPreviewResponseDto

Example

JSON
{
  "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"
      }
    }
  ]
}

Properties

7 properties 7 required

people_named boolean Required

Whether people are named: true for a reader who may see the Environment's people. Otherwise `people` and `kept` list only machine clients, and the counts still count everyone.

losing_count number Required

How many would lose at least one permission.

kept_count number Required

How many an exception role spares.

already_refused_count number Required

How many another deny already refuses there, so this one takes nothing from them.

permissions array of DenyPreviewPermissionDto Required
people DenyPreviewPeoplePageDto Required
kept array of DenyPreviewKeptDto Required

Up to 20 of those an exception role spares.

Was this page helpful?

Tell us how we can improve this guide.

Canopy