Backstage · JSON Structure

Permissions Permission Request Structure

PermissionRequest schema from Backstage permissions API

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

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

Properties

permission resourceRef

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-request-structure.json",
  "name": "PermissionRequest",
  "description": "PermissionRequest schema from Backstage permissions API",
  "type": "object",
  "properties": {
    "permission": {
      "type": "object",
      "required": [
        "type",
        "name"
      ],
      "properties": {
        "type": {
          "type": "string",
          "enum": [
            "basic",
            "resource"
          ],
          "description": "The permission type."
        },
        "name": {
          "type": "string",
          "description": "The unique permission name."
        },
        "resourceType": {
          "type": "string",
          "description": "The resource type for resource-based permissions."
        },
        "attributes": {
          "type": "object",
          "properties": {
            "action": {
              "type": "string",
              "enum": [
                "create",
                "read",
                "update",
                "delete"
              ],
              "description": "The action being performed."
            }
          }
        }
      }
    },
    "resourceRef": {
      "type": "string",
      "description": "Reference to the specific resource being accessed (e.g., component:default/my-service)."
    }
  },
  "required": [
    "permission"
  ]
}