Role Route Guard

List all route permission rules

{
  "data": [
    {
      "guard_id": "guard_a1b2c3d4",
      "route_path": "/dashboard/coordinator",
      "permitted_roles": [
        "coordinator",
        "admin"
      ],
      "redirect_path": "/unauthorized",
      "shell_branch": "coordinator_shell",
      "created_at": "2026-01-15T00:00:00Z"
    },
    {
      "guard_id": "guard_e5f6a7b8",
      "route_path": "/admin/settings",
      "permitted_roles": [
        "admin"
      ],
      "redirect_path": "/dashboard",
      "shell_branch": "admin_shell",
      "created_at": "2026-01-15T00:00:00Z"
    }
  ],
  "pagination": {
    "page": 1,
    "limit": 20,
    "total": 18
  }
}

Get a specific route permission rule

{
  "guard_id": "guard_a1b2c3d4",
  "route_path": "/dashboard/coordinator",
  "permitted_roles": [
    "coordinator",
    "admin"
  ],
  "redirect_path": "/unauthorized",
  "shell_branch": "coordinator_shell",
  "created_at": "2026-01-15T00:00:00Z"
}

Define a new route permission rule

{
  "route_path": "/reports/export",
  "permitted_roles": [
    "coordinator",
    "admin"
  ],
  "redirect_path": "/unauthorized",
  "shell_branch": "coordinator_shell"
}

{
  "guard_id": "guard_z9y8x7w6",
  "route_path": "/reports/export",
  "permitted_roles": [
    "coordinator",
    "admin"
  ],
  "redirect_path": "/unauthorized",
  "shell_branch": "coordinator_shell",
  "created_at": "2026-03-26T10:20:00Z"
}

Update permitted roles or redirect for a route rule

{
  "permitted_roles": [
    "coordinator",
    "admin",
    "supervisor"
  ],
  "redirect_path": "/access-denied"
}

{
  "guard_id": "guard_a1b2c3d4",
  "route_path": "/dashboard/coordinator",
  "permitted_roles": [
    "coordinator",
    "admin",
    "supervisor"
  ],
  "redirect_path": "/access-denied",
  "shell_branch": "coordinator_shell",
  "created_at": "2026-01-15T00:00:00Z"
}

Remove a route permission rule

{
  "deleted": true,
  "guard_id": "guard_z9y8x7w6"
}

{
  "contract_summary": {
    "total_contracts": 410,
    "total_endpoints": 2416,
    "api_styles_used": [
      "rest"
    ]
  },
  "generated_at": "2026-03-26T06:55:53.316Z"
}