Root Type for role

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/palo-alto-networks/main/json-schema/palo-alto-networks-role-schema.json",
  "title": "Root Type for role",
  "x-generated": "2026-10-04",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/palo-alto-networks-roles-api-openapi.yml#/components/schemas/role",
  "properties": {
    "aggregated_permissions": {
      "description": "Identifies all permissions available to this TSG. This is a union of the permissions available to the\nTSG, as well as the permissions available to its child TSGs.\n",
      "items": {
        "type": "string"
      },
      "type": "array"
    },
    "description": {
      "description": "",
      "type": "string"
    },
    "label": {
      "description": "The text displayed in the user interface for this role.\n",
      "type": "string"
    },
    "name": {
      "description": "The role name.\n",
      "type": "string"
    },
    "permission_sets": {
      "items": {
        "$ref": "#/$defs/permission_set_access"
      },
      "type": "array"
    },
    "permissions": {
      "description": "The permissions granted to this role.\n",
      "items": {
        "type": "string"
      },
      "type": "array"
    }
  },
  "required": [
    "label"
  ],
  "type": "object",
  "$defs": {
    "permission_set_access": {
      "description": "A permission set that you want to grant to this custom role. Permission sets are maintained by Palo Alto Networks. Use permission sets for a custom role if you are using it to grant a user access who uses the UI.",
      "properties": {
        "access_types": {
          "description": "The type of access (`read` and/or `write`) granted for this permission set.\n",
          "items": {
            "type": "string"
          },
          "type": "array"
        },
        "id": {
          "description": "The ID of a permission set included in this custom role. \n",
          "type": "string"
        }
      },
      "title": "Root Type for permission_set_access",
      "type": "object"
    }
  }
}