Permissions

Permissions are the individual capabilities that get grouped into roles. CMS Admin seeds 29 permissions covering evidence, case filing, case status/defendant management, hearings, and reporting.

The permission model

Name
id
Type
string
Description
Unique identifier for the permission.
Name
name
Type
string
Description
The permission's name, e.g. Case Raffle, Update Case Status. This is the value used in a role's permissions array and in permission: route middleware.

Seeded permissions

Name
Super Admin
Description
Catch-all permission held by the Super Admin role. Most Super Admin gates in the codebase check the role name directly rather than this permission.
Name
Case Raffle
Description
Required to raffle a case to a branch — see Case Raffle.
Name
Add Case Filing
Description
Create new case filings.
Name
View Case Filing
Description
View case filing details.
Name
Update Case Filing
Description
Edit case filing details.
Name
Update Case Branches
Description
Reassign a case's court branch.
Name
Update Case Status
Description
Required to transition a case's status — see Case Records.
Name
Update Case Defendant
Description
Required to update a case's defendant list.
Name
View Case Details
Description
View case record details.
Name
View Case Activities
Description
View a case's activities (hearings, orders, etc.).
Name
View Case History
Description
View a case's stage/status history.
Name
Add Evidence
Description
Submit new evidence to a case.
Name
View Evidence
Description
View a case's evidence.
Name
Update Evidence
Description
Edit existing evidence.
Name
Add Witness
Description
Add a testimonial witness entry.
Name
Add Hearing
Description
Schedule a new hearing.
Name
Update Hearing
Description
Reschedule or cancel a hearing.
Name
Add Activity
Description
Record a new case activity.
Name
Expunge Activity
Description
Mark a case activity as expunged.
Name
Add Counsel
Description
Add a counsel of record to a case.
Name
Add Party Complaint
Description
File a party complaint against a case.
Name
Update Minutes of the Hearing
Description
Edit minutes of the hearing documents.
Name
Update TSN
Description
Submit/update stenographic notes — see Stenographic Notes.
Name
Add Sheriffs Report
Description
Submit a sheriff's report — see Sheriff Reports.
Name
Branch of the Court Clerk
Description
General BCC-scoped access flag used alongside the Branch of the Court Clerk role.
Name
Servings
Description
Access to service-of-process workflows.
Name
Calendar
Description
Access to calendars and events.
Name
Articles
Description
Access to manage articles.
Name
Reports
Description
Access to reports and statistics.

GET/api/permissions

List all permissions

Retrieve every permission, unpaginated — used to populate the permission picker when creating or editing a role.

Request

GET

/api/permissions

curl https://your-domain.com/api/permissions \
  -H "Accept: application/json" \
  -H "X-XSRF-TOKEN: {token}" \
  --cookie "cms_admin_session={session}"

Response

{
  "data": [
    {"id": "...", "name": "Case Raffle"},
    {"id": "...", "name": "Add Case Filing"},
    {"id": "...", "name": "View Case Filing"},
    {"id": "...", "name": "Update Case Status"},
    {"id": "...", "name": "View Evidence"},
    {"id": "...", "name": "Add Evidence"},
    {"id": "...", "name": "Reports"}
  ]
}