Skip to content

PermissionsBuilderProps

@firecms/core


@firecms/core / PermissionsBuilderProps

Interface: PermissionsBuilderProps<EC, USER, M>

Section titled “Interface: PermissionsBuilderProps<EC, USER, M>”

Defined in: types/permissions.ts:35

Props passed to a PermissionsBuilder

EC extends EntityCollection = EntityCollection

USER extends User = User

M extends object = InferCollectionType<EC>

authController: AuthController<USER>

Defined in: types/permissions.ts:67

Auth controller


collection: EC

Defined in: types/permissions.ts:62

Collection these permissions apply to


entity: Entity<M> | null

Defined in: types/permissions.ts:42

Entity being edited, might be null in some cases, when the operation refers to the collection. For example, when deciding whether a user can create a new entity in a collection, the entity will be null.


path: string

Defined in: types/permissions.ts:47

Path of the collection e.g. ‘products/12345/locales’


pathSegments: string[]

Defined in: types/permissions.ts:52

Path segments of the collection e.g. [‘products’, ‘locales’]


user: USER | null

Defined in: types/permissions.ts:57

Logged in user