Skip to content

Commit

Permalink
Add user roles documentation (#120)
Browse files Browse the repository at this point in the history
  • Loading branch information
mlsmaycon authored Jan 4, 2024
1 parent bf02856 commit f0873a2
Show file tree
Hide file tree
Showing 3 changed files with 19 additions and 0 deletions.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
19 changes: 19 additions & 0 deletions src/pages/how-to/add-users-to-your-network.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,25 @@ After logging in to the system, they will join your network automatically.
This is a limitation that is likely to be removed in future versions.
</Note>

## Manage user roles
NetBird has three user roles - `Owner`, `Admin`, and `User`. The roles allow you to control the level of access to the management API of your account.

- `Owner` role - has full access to the account and can manage all aspects of the account. There can be only one account owner in NetBird. Users with the owner role can delete their organization account. See the [Delete NetBird account](/how-to/delete-account) section.
- `Admin` role - has full access to the account except that administrators can't delete or update the role of the Owner user and delete the organization account.
- `User` role - has limited access to the account, allowing users to view peers they own and others they can connect to. Users can create personal access tokens for programmatic access.

To manage user roles, proceed to the `Users` tab and click on the user you want to update:
<p>
<img src="/docs-static/img/how-to-guides/user-tab-list.png" alt="high-level-dia" className="imagewrapper"/>
</p>
After that, select the desired role from the dropdown:
<p>
<img src="/docs-static/img/how-to-guides/user-update-role.png" alt="high-level-dia" className="imagewrapper"/>
</p>
Click the `Save` button to save the changes.
<Note>
Only users with the `Owner` role can assign another user as `Owner`; this action will transfer the `Owner` role to another user, making the current user `Admin`.
</Note>
## Get started
<p float="center" >
<Button name="button" className="button-5" onClick={() => window.open("https://netbird.io/pricing")}>Use NetBird</Button>
Expand Down

0 comments on commit f0873a2

Please sign in to comment.