You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Update dashboard.md - Add documentation for hiding and restricting dashboard access
Adds a new section documenting how to hide dashboards or add conditional access rules using the extension registry.
This addresses a common gap in the documentation where developers need to:
- Hide default dashboards like the Getting Started dashboard
- Restrict dashboard access to specific user groups (e.g., admins only)
- Use extensionRegistry.exclude() and extensionRegistry.appendCondition()
Includes examples for:
- Removing dashboards completely
- Restricting to admin users only
- Restricting to multiple specific user groups using GUIDs
Copy file name to clipboardExpand all lines: 16/umbraco-cms/customizing/extending-overview/extension-types/dashboard.md
+67Lines changed: 67 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -39,6 +39,73 @@ Even though these dashboards are useful, you might want to create your own custo
39
39
40
40
You can try and [create a custom dashboard](../../../tutorials/creating-a-custom-dashboard/) as a way on getting started on this topic.
41
41
42
+
### Hiding or adding conditional rules to existing dashboards
43
+
44
+
You might need to hide or add conditions to existing dashboards. Common use cases include hiding the Getting Started dashboard or restricting the Redirect Management dashboard to Admin users only.
45
+
46
+
To do this, you will first need to [create an extension](../../../tutorials/creating-your-first-extension.md). For this example, which implements dashboard customizations, a descriptive name like `DashboardCustomization` works well:
Use the `onInit` function to configure the dashboard removal and customization. The optional `onUnload` function can clean up any customizations when the extension is disposed:
// Note: In most cases, cleanup is not necessary as the extension registry
84
+
// handles this automatically when the backoffice reloads
85
+
}
86
+
```
87
+
{% endcode %}
88
+
89
+
#### Restricting to specific user groups
90
+
91
+
To allow multiple user groups (for example, Admin OR a custom group), use the `Umb.Condition.CurrentUser.GroupId` condition with the `oneOf` parameter:
0 commit comments