1. Docs
  2. API Reference
  3. IdentityAccessibleNodesResponseDto

IdentityAccessibleNodesResponseDto

Example

JSON
{
  "permission": "reports.view",
  "env_wide": false,
  "roots": [
    "string"
  ],
  "nodes": [
    "string"
  ],
  "complete": false
}

Properties

5 properties 5 required

permission string Required
Examplereports.view
env_wide boolean Required

True when a root is the Environment's own root, so every node qualifies and a list needs no filter. `nodes` is null then.

roots array of string Required

The nodes the permission is granted at, in effect now, that no other such node already covers. Each reaches everything beneath it.

nodes array of string Required

Every node beneath the roots, the roots included, for an `IN (...)` filter. Null when `env_wide`, or when there are more than `max_nodes` (then `complete` is false and the caller filters by `roots` instead).

nullable
complete boolean Required

False when the set beneath the roots was larger than `max_nodes` and was not sent.

Was this page helpful?

Tell us how we can improve this guide.