Skip to main content
Version: 2.0.0

Interface: PermissionsBuilderProps<EC, UserType, M>

Props passed to a PermissionsBuilder

Type parameters​

NameType
ECextends EntityCollection = EntityCollection
UserTypeextends User = User
Mextends object = InferCollectionType<EC>

Properties​

authController​

• authController: AuthController<UserType>

Auth controller

Defined in​

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


collection​

• collection: EC

Collection these permissions apply to

Defined in​

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


entity​

• entity: null | 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/src/types/permissions.ts:42


pathSegments​

• pathSegments: string[]

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

Defined in​

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


user​

• user: null | UserType

Logged in user

Defined in​

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

Enterprise or start-up?

Learn how to get the most out of your project with the help of our consulting team.
Learn more
Sign up to our newsletter to get the latest news and updates. No spam!