Get a list of all RBAC permissions grouped by resource type Run in API Explorer

GET /api/v1/static/rbac-permissions

Responses

  • 200 application/json
    Hide response attribute Show response attribute object
    • data object
      Hide data attributes Show data attributes object
      • groups object
        Hide groups attributes Show groups attributes object
        • super string
        • user-and-accounts string
        • firm string
        • roles-and-permissions string
        • case string
        • client string
      • permissions object
        Hide permissions attributes Show permissions attributes object
        • case array[object]
          Hide case attributes Show case attributes object
          • value string
          • label string
        • client array[object]
          Hide client attributes Show client attributes object
          • value string
          • label string
        • firm array[object]
          Hide firm attributes Show firm attributes object
          • value string
          • label string
        • roles-and-permissions array[object]
          Hide roles-and-permissions attributes Show roles-and-permissions attributes object
          • value string
          • label string
        • user-and-accounts array[object]
          Hide user-and-accounts attributes Show user-and-accounts attributes object
          • value string
          • label string
GET /api/v1/static/rbac-permissions
curl \
 --request GET 'https://api.plannrcrm.com/api/v1/static/rbac-permissions' \
 --header "Authorization: Bearer $ACCESS_TOKEN"
Response examples (200)
{
  "data": {
    "groups": {
      "case": "Case",
      "firm": "Firms",
      "super": "Super",
      "client": "Clients",
      "user-and-accounts": "Users & Accounts",
      "roles-and-permissions": "Roles & Permissions"
    },
    "permissions": {
      "case": [
        {
          "label": "Full Access to Cases",
          "value": "case:*"
        },
        {
          "label": "Create Cases",
          "value": "case:create"
        },
        {
          "label": "View Cases",
          "value": "case:read"
        },
        {
          "label": "Update Cases",
          "value": "case:update"
        },
        {
          "label": "Delete Cases",
          "value": "case:delete"
        }
      ],
      "firm": [
        {
          "label": "Full Access to Firms",
          "value": "firm:*"
        },
        {
          "label": "Create Firms",
          "value": "firm:create"
        },
        {
          "label": "View Firms",
          "value": "firm:read"
        },
        {
          "label": "Update Firms",
          "value": "firm:update"
        },
        {
          "label": "Delete Firms",
          "value": "firm:delete"
        }
      ],
      "client": [
        {
          "label": "Create Clients",
          "value": "client:create"
        },
        {
          "label": "View All Clients",
          "value": "client:readAll"
        },
        {
          "label": "View By Group Clients",
          "value": "client:readByGroup"
        },
        {
          "label": "Update Clients",
          "value": "client:update"
        },
        {
          "label": "Delete Clients",
          "value": "client:delete"
        }
      ],
      "user-and-accounts": [
        {
          "label": "Full Access to Users",
          "value": "user:*"
        },
        {
          "label": "Create Users",
          "value": "user:create"
        },
        {
          "label": "View Users",
          "value": "user:read"
        },
        {
          "label": "Update Users",
          "value": "user:update"
        },
        {
          "label": "Delete Users",
          "value": "user:delete"
        }
      ],
      "roles-and-permissions": [
        {
          "label": "Full Access to Rolse",
          "value": "role:*"
        },
        {
          "label": "Create Rolse",
          "value": "role:create"
        },
        {
          "label": "View Rolse",
          "value": "role:read"
        },
        {
          "label": "Update Rolse",
          "value": "role:update"
        },
        {
          "label": "Delete Rolse",
          "value": "role:delete"
        },
        {
          "label": "Create Role Assignments",
          "value": "role-assign:create"
        },
        {
          "label": "Delete Role Assignments",
          "value": "role-assign:delete"
        }
      ]
    }
  }
}