mirror of
https://github.com/netbirdio/docs.git
synced 2026-10-19 03:59:05 +02:00
Document the Permissions settings tab (#931)
* Add new permissions page and fix zero trust doc * Remove API mention
This commit is contained in:
@@ -0,0 +1,57 @@
|
||||
export const description = 'Control how much of the NetBird dashboard regular users and billing admins can see, including whether they can view peers.'
|
||||
|
||||
# Permissions
|
||||
|
||||
The `Permissions` tab in your account settings controls how much of the dashboard non-administrative users can see. It currently holds a single setting, `Restrict dashboard for regular users`.
|
||||
|
||||
To find it, log in to your NetBird dashboard and navigate to `Settings` > `Permissions`.
|
||||
|
||||
<p>
|
||||
<img src="/docs-static/img/manage/settings/permissions-restrict-dashboard.png" alt="Restrict dashboard for regular users setting in the Permissions tab" className="imagewrapper-big"/>
|
||||
</p>
|
||||
|
||||
## Restrict dashboard for regular users
|
||||
|
||||
When this setting is enabled, affected users get a reduced dashboard and cannot view any peers, including the peers they own themselves.
|
||||
|
||||
<Note>
|
||||
This setting is **enabled by default** on new accounts. If you want regular users to be able to see their own peers, you need to turn it off explicitly.
|
||||
</Note>
|
||||
|
||||
### Who it applies to
|
||||
|
||||
The restriction applies to users with the following roles:
|
||||
|
||||
- `User` (regular users)
|
||||
- `Billing Admin`
|
||||
|
||||
Owners and administrators are never affected, and neither are service users acting through an access token with the appropriate permissions.
|
||||
|
||||
<Note>
|
||||
Despite the name, the setting also restricts billing admins. If you have billing admins who need to see peers, this setting has to be off.
|
||||
</Note>
|
||||
|
||||
### What changes when it is enabled
|
||||
|
||||
Affected users keep their network access. The restriction is about visibility in the dashboard, not connectivity. Their peers stay connected and policies continue to apply as normal.
|
||||
|
||||
In the dashboard, those users see the following:
|
||||
|
||||
- The `Peers` page shows a blocked view instead of the peers table
|
||||
- Peer and group detail pages are not reachable and redirect back
|
||||
- Group and country data is not loaded
|
||||
- Parts of the navigation and account menu are hidden
|
||||
|
||||
Through the API, peer listing endpoints return an empty list for those users rather than an error.
|
||||
|
||||
### What changes when it is disabled
|
||||
|
||||
Turning the setting off does not give regular users visibility of the whole network. They see only the peers they own, which is the standard behavior for the `User` role. Administrators continue to see all peers in the account either way.
|
||||
|
||||
## Changing the setting
|
||||
|
||||
1. Go to `Settings` > `Permissions`.
|
||||
2. Toggle `Restrict dashboard for regular users` on or off.
|
||||
3. Click `Save Changes`.
|
||||
|
||||
You need permission to update account settings to change this, which in practice means an owner or administrator.
|
||||
Reference in New Issue
Block a user