Skip to content

Commit 01de95b

Browse files
committed
provide mitigation ideas to one account per user limit
1 parent d4b7cb3 commit 01de95b

File tree

1 file changed

+45
-26
lines changed

1 file changed

+45
-26
lines changed

src/pages/how-to/add-users-to-your-network.mdx

Lines changed: 45 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,3 @@
1-
21
# Add users to your network
32

43
Whether you have a network for personal use or manage your company's corporate network, you'd probably want to invite
@@ -7,12 +6,14 @@ people to your account and join your NetBird network.
76
There are three ways of adding users to a NetBird account - indirect, direct, and via IdP (Identity Provider) sync.
87

98
## Indirect user invites
9+
1010
This way of adding users is managed by the NetBird system and doesn't require administrator input.
1111
It works only for organizations with private domains.
1212

1313
Whenever a new user signs up with a private domain (e.g., @netbird.io),
1414
NetBird creates a new account and associates it with the netbird.io organization (domain) automatically.
15-
Every consequent user signup with the same @netbird.io domain in their email address will end up under the same organization.
15+
Every consequent user signup with the same @netbird.io domain in their email address will end up under the same
16+
organization.
1617

1718
<Note>
1819
This feature isn't available in the self-hosted setup. By default, all users are joining the same network instead.
@@ -31,9 +32,12 @@ Public domains are the ones of the public email providers like Gmail.
3132
</Note>
3233

3334
## Direct user invites
35+
3436
As the name stands, this way of inviting users is straightforward and works through the web UI.
35-
To invite a new user, proceed to `Team` then select the `Users` tab and click the <button name="button" className="button-6">Invite User</button> button.
36-
A window will appear, allowing you to specify the name and email address of the user you want to invite. Optionally, you could select a set of groups with which you want this user to be associated.
37+
To invite a new user, proceed to `Team` then select the `Users` tab and click
38+
the <button name="button" className="button-6">Invite User</button> button.
39+
A window will appear, allowing you to specify the name and email address of the user you want to invite. Optionally, you
40+
could select a set of groups with which you want this user to be associated.
3741

3842
The invited users will receive an email invitation that they have to confirm.
3943
After logging in to the system, they will join your network automatically.
@@ -45,6 +49,14 @@ After logging in to the system, they will join your network automatically.
4549
<Note>
4650
If a user already has a NetBird account, you can't invite them.
4751
This is a limitation that is likely to be removed in future versions.
52+
53+
You can mitigate this issue with those approaches:
54+
- invite an aliased email (most email providers support those),
55+
for example invite `[email protected]` instead of `[email protected]`,
56+
- ask the user to log in and delete his/her organization (if it's the only user in the organization),
57+
- ask the user organization's Admin/Owner to delete their user account,
58+
- (optionally) transfer the Owner and/or Admin role to somebody else at user's ogranization first,
59+
4860
</Note>
4961

5062
## Identity Provider (IdP) Sync
@@ -60,30 +72,36 @@ button.
6072
See the [Provision Users and Groups From Your Identity Provider](/how-to/idp-sync) section for more details.
6173

6274
## Manage user roles
63-
NetBird has five user roles - `Owner`, `Admin`, `Network Admin`, `Auditor` and `User`. The roles allow you to control the level of access to the management API of your account.
6475

65-
- `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 for more.
66-
- `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.
67-
- `Network Admin` role - has access to manage network configurations, including access policies, DNS settings, networks, and network routes, but they can only view user and device information and general settings.
68-
- `Auditor` role - can read all configurations but not modify any of them.
69-
- `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.
70-
71-
| | Owner | Admin | Network Admin | User | Auditor |
72-
| --: | :--: | :--: | :--: | :--: | :--: |
73-
| Peers ||| 📖 | 📖 | 📖 |
74-
| Setup Keys ||| 📖 || 📖 |
75-
| Access Control ||||| 📖 |
76-
| Networks ||||| 📖 |
77-
| Network Routes ||||| 📖 |
78-
| DNS ||||| 📖 |
79-
| Team ||| 📖 || 📖 |
80-
| Activity ||| 📖 || 📖 |
81-
| Settings ||| 📖 || 📖 |
82-
83-
| |
84-
|-:|
85-
|✅ = Full access \| 📖 = Read only \| ❌ = No access|
76+
NetBird has five user roles - `Owner`, `Admin`, `Network Admin`, `Auditor` and `User`. The roles allow you to control
77+
the level of access to the management API of your account.
8678

79+
- `Owner` role - has full access to the account and can manage all aspects of the account. There can be only one account
80+
owner in NetBird. Users with the owner role can delete their organization account. See
81+
the [Delete NetBird account](/how-to/delete-account) section for more.
82+
- `Admin` role - has full access to the account except that administrators can't delete or update the role of the Owner
83+
user and delete the organization account.
84+
- `Network Admin` role - has access to manage network configurations, including access policies, DNS settings, networks,
85+
and network routes, but they can only view user and device information and general settings.
86+
- `Auditor` role - can read all configurations but not modify any of them.
87+
- `User` role - has limited access to the account, allowing users to view peers they own and others they can connect to.
88+
Users can create personal access tokens for programmatic access.
89+
90+
| | Owner | Admin | Network Admin | User | Auditor |
91+
|---------------:|:-----:|:-----:|:-------------:|:----:|:-------:|
92+
| Peers ||| 📖 | 📖 | 📖 |
93+
| Setup Keys ||| 📖 || 📖 |
94+
| Access Control ||||| 📖 |
95+
| Networks ||||| 📖 |
96+
| Network Routes ||||| 📖 |
97+
| DNS ||||| 📖 |
98+
| Team ||| 📖 || 📖 |
99+
| Activity ||| 📖 || 📖 |
100+
| Settings ||| 📖 || 📖 |
101+
102+
| |
103+
|---------------------------------------------------:|
104+
| ✅ = Full access \| 📖 = Read only \| ❌ = No access |
87105

88106
To manage user roles, proceed to the `Users` tab and click on the user you want to update:
89107
<p>
@@ -99,6 +117,7 @@ Click the `Save` button to save the changes.
99117
</Note>
100118

101119
## Get started
120+
102121
<p float="center" >
103122
<Button name="button" className="button-5" onClick={() => window.open("https://netbird.io/pricing")}>Use NetBird</Button>
104123
</p>

0 commit comments

Comments
 (0)