Permissions

KIO user permissions and the built-in permission catalog.

Concepts

Permission: a name and a unique slug. Endpoints check the slug, e.g. users-users-read.

Catalog: the built-in catalog maps modules to submodules to actions. Each <Module> <Submodule> <action> triple becomes one permission whose slug is the triple lowercased and hyphenated.

Seeding: the generate-permissions endpoints insert the catalog into the database. They are not idempotent: run them only on an empty collection, because duplicate slugs raise unhandled errors that terminate the API process.

Business permissions: business users use a separate permission collection, seeded by Generate business user permissions.

Endpoints

List KIO user permissions

GET /v1/permissions

Every KIO user permission, sorted by name.

Create a KIO user permission

POST /v1/permissions

Creates a permission; the slug is derived from the name.

Delete a KIO user permission

DELETE /v1/permissions/{id}

Deletes a permission.

Generate KIO user permissions

GET /v1/config/generate-permissions

Seeds the KIO user permissions from the catalog.

Generate business user permissions

GET /v1/config/generate-permissions-business

Seeds the business user permissions from the catalog.

Source

Router: routes/v1/users.js

Controllers: controllers/users/users-permissions.js, controllers/business/business-roles-permissions.js

Models: models/user_permission.js, models/business_user_permission.js

Overview

Permissions#

Concepts#

Endpoints#

List KIO user permissions#

Create a KIO user permission#

Delete a KIO user permission#

Generate KIO user permissions#

Generate business user permissions#

Source#