Skip to main content
zerotal

Documentation


Documentation / @zerotal/admin / index / Role

Interface: Role

Defined in: admin/src/roles.ts:40

A named set of permissions.

Properties

id

id: string

Defined in: admin/src/roles.ts:41


name

name: string

Defined in: admin/src/roles.ts:42


description?

optional description?: string

Defined in: admin/src/roles.ts:44

Optional description, shown under the name.


superuser?

optional superuser?: boolean

Defined in: admin/src/roles.ts:51

A role that holds every permission, present and future.

Worth modelling explicitly rather than by ticking every box: an administrator should not silently lose access to a resource added next week.