Skip to content

Commit

Permalink
note on permissions
Browse files Browse the repository at this point in the history
  • Loading branch information
piggydoughnut committed May 27, 2024
1 parent 1358084 commit ff55a65
Show file tree
Hide file tree
Showing 3 changed files with 79 additions and 1 deletion.
3 changes: 2 additions & 1 deletion documentation/pages/framework/configuration/modules.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,8 @@ This is where you turn on/off app modules, set their integrations, metadata and
```
{
"id": "announcements",
"enabled": true
"enabled": true,
"enabledIntegrations": [],
}
```

Expand Down
77 changes: 77 additions & 0 deletions documentation/pages/framework/configuration/permissions.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,77 @@
# Permissions

You can define custom access permissions and custom roles here. Permissions for each module are defined in the `src/modules/<Module-name>/permissions.ts`

// @TODO - Update the config-demo with admin permissions

// @TODO - Add a list of available permissions

E.g.

```
{
"roleGroups": [
{
"id": "base",
"name": "Base user roles",
"roles": [
{
"id": "regular",
"name": "HubMember",
"permissions": [
"users.list_profiles",
"users.manage_profile",
"users.use_map",
"users.use_onboarding",
"visits.list_visitors",
"visits.create",
"guest-invites.create",
"room-reservation.create",
"search.use",
"events.list_global_events",
"events.list_participants",
"quick-navigation.use",
"profile-questions.use",
"help-center.get_content",
"checklists.use",
"announcements.use"
],
"accessByDefault": true
}
]
},
{
"id": "admins",
"name": "Admins 🔥",
"roles": [
{
"id": "admin",
"name": "Admin",
"permissions": [
"users.__admin",
"users.admin.list",
"users.admin.manage",
"users.admin.assign_roles",
"users.list_profiles",
"users.manage_profile",
"users.use_map",
"users.use_onboarding",
"visits.__admin",
"events.admin.manage",
"events.list_global_events
"checklists.admin.manage",
"announcements.__admin",
"announcements.use",
"working-hours.__admin",
"working-hours.admin.list",
"working-hours.admin.manage",
"admin-dashboard.__admin",
"memberships.__admin"
],
"accessByDefault": true
}
]
}
]
}
```
Empty file.

0 comments on commit ff55a65

Please sign in to comment.