Backstage · JSON Structure

Permissions Permission Decision Structure

PermissionDecision schema from Backstage permissions API

Type: object Properties: 4 Required: 1
Developer PortalInternal Developer PlatformSoftware CatalogOpen Source

PermissionDecision is a JSON Structure definition published by Backstage, describing 4 properties, of which 1 is required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

result pluginId resourceType conditions

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/backstage/refs/heads/main/json-structure/permissions-permission-decision-structure.json",
  "name": "PermissionDecision",
  "description": "PermissionDecision schema from Backstage permissions API",
  "type": "object",
  "properties": {
    "result": {
      "type": "string",
      "enum": [
        "ALLOW",
        "DENY",
        "CONDITIONAL"
      ],
      "description": "The authorization decision result."
    },
    "pluginId": {
      "type": "string",
      "description": "The plugin responsible for condition evaluation."
    },
    "resourceType": {
      "type": "string",
      "description": "The resource type for conditional decisions."
    },
    "conditions": {
      "type": "object",
      "description": "The conditions that must be evaluated against the resource to produce a final decision. Only present when result is CONDITIONAL."
    }
  },
  "required": [
    "result"
  ]
}