Role
@firecms/core / Role
Type Alias: Role
Section titled “Type Alias: Role”Role =
object
Defined in: types/roles.ts:3
Properties
Section titled “Properties”collectionPermissions?
Section titled “collectionPermissions?”
optionalcollectionPermissions:Record<string,Permissions>
Defined in: types/roles.ts:31
Record of stripped collection ids to their permissions.
stripCollectionPath
config?
Section titled “config?”
optionalconfig:object
Defined in: types/roles.ts:36
Permissions related to editing the collections
createCollections?
Section titled “createCollections?”
optionalcreateCollections:boolean
deleteCollections?
Section titled “deleteCollections?”
optionaldeleteCollections:boolean|"own"
editCollections?
Section titled “editCollections?”
optionaleditCollections:boolean|"own"
defaultPermissions?
Section titled “defaultPermissions?”
optionaldefaultPermissions:Permissions
Defined in: types/roles.ts:25
Default permissions for all collections for this role. You can override this values at the collection level using collectionPermissions
id:
string
Defined in: types/roles.ts:8
ID of the role
isAdmin?
Section titled “isAdmin?”
optionalisAdmin:boolean
Defined in: types/roles.ts:18
If this flag is true, the user can perform any action
name:
string
Defined in: types/roles.ts:13
Name of the role
