1. Docs
  2. API Reference
  3. EvaluateResponseDto

EvaluateResponseDto

Example

JSON
{
  "allowed": false,
  "permission": "string",
  "scope_evaluated": "node",
  "effective_node_id": "string",
  "granting_roles": [
    "string"
  ],
  "denial_reason": "string"
}

Properties

6 properties 4 required

allowed boolean Required
permission string Required
scope_evaluated enum Required

Echo of the `scope` the caller asked for. `app_wide` answers are 'matched somewhere in the tree' — never treat them as scoped to a specific node.

Enumnodeapp_wide
effective_node_id string Optional

The hierarchy node the decision was anchored to. Always set for `scope_evaluated: "node"`; always null for `scope_evaluated: "app_wide"` because the answer is org-scoped, not node-scoped.

nullable
granting_roles array of string Required
denial_reason string Optional
nullable
Was this page helpful?

Tell us how we can improve this guide.