Type Alias: Role

Role: object

Type declaration

collectionPermissions?

optional collectionPermissions: Record<string, Permissions>

Record of stripped collection ids to their permissions.

See

stripCollectionPath

config?

optional config: object

config.createCollections?

optional createCollections: boolean

config.deleteCollections?

optional deleteCollections: boolean | "own"

config.editCollections?

optional editCollections: boolean | "own"

defaultPermissions?

optional defaultPermissions: Permissions

Default permissions for all collections for this role. You can override this values at the collection level using collectionPermissions

id

id: string

ID of the role

isAdmin?

optional isAdmin: boolean

If this flag is true, the user can perform any action

name

name: string

Name of the role

Defined in

packages/firecms_core/src/types/roles.ts:3