NodeDeletePreviewDto

Example

JSON

{
  "node_id": "string",
  "version": 0,
  "people_named": false,
  "blockers": [
    {
      "code": "hierarchy.reparent_cycle",
      "message": "string"
    }
  ],
  "subtree_size": 0,
  "identities_affected": 0,
  "identities_losing_all_access": 0,
  "roles": [
    {
      "role": {
        "id": "string",
        "name": "string"
      },
      "assignments": 0,
      "identities": 0
    }
  ],
  "assignments_total": 0,
  "people": {
    "items": [
      {
        "identity": {
          "id": "string",
          "first_name": "string",
          "last_name": "string",
          "name": "string",
          "email": "string",
          "avatar_url": "string"
        },
        "via": [
          {
            "role": {
              "id": null,
              "name": null
            },
            "node": {
              "id": null,
              "name": null
            }
          }
        ]
      }
    ],
    "pagination": {
      "page": 0,
      "take": 0,
      "item_count": 0,
      "page_count": 0,
      "has_previous_page": false,
      "has_next_page": false
    }
  },
  "invites": {
    "total": 0,
    "names": [
      "string"
    ]
  },
  "directory_groups": {
    "total": 0,
    "names": [
      "string"
    ]
  }
}

Properties

12 properties 12 required

node_id string Required

version number Required

The node's version now: send it as `If-Match` on the delete

people_named boolean Required

Whether people are named: false for a reader who may not see the Environment's people

blockers array of PreviewBlockerDto Required

What would refuse the delete. When any is listed, nothing below is counted

subtree_size number Required

The node and every node beneath it

identities_affected number Required

Identities holding an assignment that goes

identities_losing_all_access number Required

Identities holding no assignment anywhere else in the Environment, left with no access

roles array of RoleRemovalCountDto Required

The assignments that go, counted by role

assignments_total number Required

How many assignments go in all

people object Required

One page of the people whose assignments go. The counts above cover everyone; the page follows the query

invites object Required

Pending invitations revoked, by email (none listed unless `people_named`)

directory_groups object Required

Directory groups unmapped, by name

Was this page helpful?

Tell us how we can improve this guide.