Skip to main content
Version: 3.0.0-beta

Interface: PermissionsBuilderProps<EC, USER, M>

Props passed to a PermissionsBuilder

Type Parameters​

• EC extends EntityCollection = EntityCollection

• USER extends User = User

• M extends object = InferCollectionType<EC>

Properties​

authController​

authController: AuthController<USER>

Auth controller

Defined in​

packages/firecms_core/src/types/permissions.ts:67


collection​

collection: EC

Collection these permissions apply to

Defined in​

packages/firecms_core/src/types/permissions.ts:62


entity​

entity: Entity<M>

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.

Defined in​

packages/firecms_core/src/types/permissions.ts:42


path​

path: string

Path of the collection e.g. 'products/12345/locales'

Defined in​

packages/firecms_core/src/types/permissions.ts:47


pathSegments​

pathSegments: string[]

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

Defined in​

packages/firecms_core/src/types/permissions.ts:52


user​

user: USER

Logged in user

Defined in​

packages/firecms_core/src/types/permissions.ts:57

Sign up to our newsletter to get the latest news and updates. No spam!