Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Binary file not shown.
12 changes: 6 additions & 6 deletions src/pages/manage/team/add-users-to-your-network.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -37,11 +37,13 @@ As the name stands, this way of inviting users is straightforward and works thro
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.
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.

The invited users will receive an email invitation that they have to confirm.
On NetBird Cloud, invited users receive an email invitation that they have to confirm.
After logging in to the system, they will join your network automatically.

On a self-hosted installation the same button reads `Add User`, and it only appears when [local user management](/selfhosted/identity-providers/local) is enabled. Select **Invite User** to generate an invite link that you share with the user, or **Create User** to generate a password that you share securely. See [local user management](/selfhosted/identity-providers/local#user-management) for the steps. If you have [disabled local authentication](/selfhosted/identity-providers/disable-local-authentication), the button is disabled and users have to come from your IdP instead.

<p>
<img src="/docs-static/img/manage/team/user-invites.png" alt="high-level-dia" className="imagewrapper"/>
<img src="/docs-static/img/manage/team/user-invites.png" alt="The Invite User dialog with name, email, and group fields" className="imagewrapper"/>
</p>

<Note>
Expand All @@ -52,12 +54,10 @@ After logging in to the system, they will join your network automatically.

## Identity Provider (IdP) Sync

NetBird's IdP-Sync automates user access management by integrating with your IdP and automatically
provisioning users and groups. You can enable this feature from the `Users` tab by clicking the `Identity Provider Sync`
button.
NetBird's IdP-Sync automates user access management by integrating with your IdP and automatically provisioning users and groups. You configure it from the `Integrations` page, on the `Identity Provider Sync` tab.

<p>
<img src="/docs-static/img/manage/team/idp-sync-reference.png" alt="idp-sync-reference" className="imagewrapper"/>
<img src="/docs-static/img/manage/team/idp-sync-reference.png" alt="The Identity Provider Sync tab on the Integrations page" className="imagewrapper"/>
</p>

See the [Provision Users and Groups From Your Identity Provider](/manage/team/idp-sync) section for more details.
Expand Down
12 changes: 10 additions & 2 deletions src/pages/manage/team/approve-users.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ Navigate to the Dashboard's `Settings` page and the `Authentication` tab and ena
- **Disabled**: Manual approval for new users is not required. Users joining via domain matching will be automatically added to the organization.

<p>
<img src="/docs-static/img/manage/team/approve-users/netbird-authentication-settings-approval.png" alt="netbird-authentication-settings-approval" className="imagewrapper-big"/>
<img src="/docs-static/img/manage/team/approve-users/netbird-authentication-settings-approval.png" alt="The User Approval Required toggle on the Authentication tab of Settings" className="imagewrapper-big"/>
</p>

## Approve or reject user
Expand All @@ -24,9 +24,17 @@ To approve a user, navigate to the [Users Page](https://app.netbird.io/team/user
While they wait, the user sees a **Waiting for Approval** screen that names the account owner's email address, partly hidden, when NetBird can look it up. Otherwise it just asks them to contact the account owner. Any admin can approve them, not only the owner. Once approved, the user clicks **Refresh** on that screen to join the account.

<p>
<img src="/docs-static/img/manage/team/approve-users/netbird-user-approval.png" alt="netbird-user-approval" className="imagewrapper-big"/>
<img src="/docs-static/img/manage/team/approve-users/netbird-user-approval.png" alt="Approve and Reject buttons on a pending user row in the Users table" className="imagewrapper-big"/>
</p>

Pending users have the `Pending` status in the `Users` table. When several people are waiting, the `Pending Approval` button above the table filters it down to just those users, and carries a badge with the number outstanding. The button only appears while at least one user is waiting.

<Note>
`Reject` removes the user from the account, and that removal can't be undone. A rejected user can sign in again and be recreated as pending; rejection does not permanently block future sign-ins.
</Note>

The `Approve` and `Reject` buttons only render for roles that can update users, which means `Owner` and `Admin`. A `Network Admin` has read-only access to the `Team` tab and won't see them. See [User Roles](/manage/team/user-roles) for the full breakdown.

## Get started
<div>
<Button name="button" className="button-5" onClick={() => window.open("https://netbird.io/pricing")}>Use NetBird</Button>
Expand Down
19 changes: 12 additions & 7 deletions src/pages/manage/team/auto-offboard-users.mdx
Original file line number Diff line number Diff line change
@@ -1,20 +1,22 @@
# Automatically Offboard Team Members from NetBird

[NetBird's IdP-Sync integration](https://docs.netbird.io/manage/team/idp-sync) simplifies offboarding team members, enhancing
[NetBird's IdP-Sync integration](/manage/team/idp-sync) simplifies offboarding team members, enhancing
security and efficiency. With this integration, you can automatically revoke access when users leave the company, when
temporary access for a freelancer ends after project completion, or when a seasonal employee's contract concludes.
Likewise, you can use this integration to restrict access to specific resources or environments when a project finishes.
For instance, you can limit network and resource access when a team member is removed from a group or when an entire group
is deleted from your Identity Provider.

Automatic removal applies to users managed by the IdP-Sync integration. SCIM does not manage users created or invited directly in NetBird; remove those users manually in NetBird when offboarding. Group-based access revocation also depends on the [user group propagation setting](#revoking-group-access).

## Removing Team Members

In this tutorial, we will focus on `user_01`, `user_02`, and `user_03`. From NetBird's `Users` dashboard, you can see
that `user_01` is part of the `IT Administrators` group, while `user_02` and `user_03` belong to the `Staging` group.

![NetBird Users](/docs-static/img/manage/team/auto-offboard-users/GT3eAeU.png)
![The NetBird Users table showing the three example users and their groups](/docs-static/img/manage/team/auto-offboard-users/GT3eAeU.png)

To get started, access your Identity Provider (IdP) dashboard. For this example, we'll use [Microsoft Entra ID (Azure AD)](https://docs.netbird.io/manage/team/idp-sync/microsoft-entra-id-sync).
To get started, access your Identity Provider (IdP) dashboard. For this example, we'll use [Microsoft Entra ID (Azure AD)](/manage/team/idp-sync/microsoft-entra-id-sync).

Next, locate the user you want to offboard in your IdP's user management section. Let’s say you want to revoke access to
`user_01`, in that case, you will need to select it and click the `Delete` button as shown below.
Expand All @@ -25,7 +27,9 @@ After deletion, click the `Refresh` button to confirm that the user is no longer

![IdP Confirm Deletion](/docs-static/img/manage/team/auto-offboard-users/LJ6QHRV.png)

Wait for the NetBird integration to complete its next synchronization cycle, which usually takes 300 seconds. Alternatively, go to the `Integrations` screen in the NetBird admin console and click the corresponding integration button to manually trigger the synchronization.
For the Entra ID API integration used in this example, wait for the next synchronization cycle, which usually takes 300 seconds. Alternatively, go to `Integrations` in the NetBird dashboard, open the `Identity Provider Sync` tab, and trigger the synchronization manually.

Manual sync in NetBird is only available for the API-based integrations, Google Workspace and Microsoft Entra ID via API. SCIM-based integrations send changes from the IdP on the provider's provisioning schedule. For example, [Entra ID (SCIM)](/manage/team/idp-sync/microsoft-entra-id-scim-sync#start-provisioning) normally runs approximately every 40 minutes after the initial sync. To request an earlier update, use your IdP's on-demand provisioning option if it provides one. Confirm that the user has been removed in NetBird before treating offboarding as complete.

![NetBird Integrations Force Sync](/docs-static/img/manage/team/auto-offboard-users/ogiiUeT.png)

Expand All @@ -35,6 +39,8 @@ Now, go to NetBird's `Users` dashboard to verify that the user is no longer list

## Revoking Group Access

For changes to a user's IdP group memberships to update their peers, [Enable user group propagation](/manage/settings/groups#enable-user-group-propagation) must be enabled in `Settings` > `Groups`. When it is disabled, peers retain their existing group memberships, even after the user's groups change. Update the peer memberships manually in NetBird to revoke access granted through those groups.

Imagine a scenario where you have an access policy that grants all members of the `Staging` group access to resources in the `Servers` group.

![NetBird Access Control](/docs-static/img/manage/team/auto-offboard-users/sATMbbP.png)
Expand All @@ -44,7 +50,6 @@ Let's say the current project is finished, and you no longer want members of the

![IdP Delete Group](/docs-static/img/manage/team/auto-offboard-users/TOZjFKC.png)

Once the changes synchronize in NetBird, users and their group memberships will be updated; therefore,
[network access associated with that group](https://docs.netbird.io/manage/access-control/manage-network-access) will automatically be revoked.
Once the changes synchronize in NetBird, verify that the affected peers no longer belong to the `Staging` group and no longer have [network access through that group](/manage/access-control/manage-network-access). If peer memberships remain, remove them manually before treating the revocation as complete.

![NetBird No Group](/docs-static/img/manage/team/auto-offboard-users/NKabmN6.png)
![NetBird No Group](/docs-static/img/manage/team/auto-offboard-users/NKabmN6.png)
23 changes: 15 additions & 8 deletions src/pages/manage/team/entra-id-app-enablement.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,29 +2,36 @@ import {Note} from "@/components/mdx";

# Enable NetBird for Microsoft Entra ID

Before your organization can use Microsoft Entra ID features with NetBird — such as user provisioning, group sync, or single sign-on — you need to enable the NetBird enterprise application in your Entra ID tenant and grant admin consent.
This guide explains how to grant tenant-wide admin consent to the NetBird enterprise application in your Microsoft Entra ID tenant. API-based user and group provisioning uses a separate app registration, covered in the [Entra ID (API) setup guide](/manage/team/idp-sync/microsoft-entra-id-sync).

## Prerequisites

- A Microsoft Entra ID tenant
- An account with **Global Administrator** or **Cloud Application Administrator** role
- An account with the **Cloud Application Administrator**, **Application Administrator**, **Privileged Role Administrator**, or **Global Administrator** role

<Note>
The required role depends on the permissions requested. **Cloud Application Administrator** and **Application Administrator** can consent to delegated permissions, including Microsoft Graph delegated permissions. If the application requests Microsoft Graph **application permissions**, use a **Privileged Role Administrator** or **Global Administrator** for the consent step. Review the requested permissions and Microsoft's [admin consent requirements](https://learn.microsoft.com/en-us/entra/identity/enterprise-apps/grant-admin-consent#prerequisites).
</Note>

## Step 1: Find the NetBird Enterprise Application

1. Sign in to the [Azure portal](https://portal.azure.com)
2. Navigate to **Home** → **Microsoft Entra ID** → **Enterprise Applications**
1. Sign in to the [Microsoft Entra admin center](https://entra.microsoft.com)
2. Navigate to **Entra ID** → **Enterprise apps** → **All applications**
3. Search for the application with Application ID: `7a7538de-b7ed-4e49-befe-edbe74d5e0a1`
4. Select the **NetBird** application from the results

You can reach the same blade from the [Azure portal](https://portal.azure.com) under
**Microsoft Entra ID** → **Enterprise applications**.

<p>
<img src="/docs-static/img/manage/team/entra-id-app-enablement/enterprise-applications.png" alt="Find NetBird in Enterprise Applications" className="imagewrapper-big"/>
</p>

## Step 2: Grant Admin Consent

1. In the NetBird application overview, click **Permissions** in the left menu
2. Click **Grant admin consent for Default Directory**
3. Review the requested permissions and confirm
1. In the NetBird application overview, select **Permissions** under **Security**
2. Review the requested permissions carefully, then click **Grant admin consent for `<your tenant name>`**
3. Confirm the consent prompt

<p>
<img src="/docs-static/img/manage/team/entra-id-app-enablement/grant-admin-consent.png" alt="Grant admin consent for NetBird" className="imagewrapper-big"/>
Expand All @@ -36,7 +43,7 @@ Before your organization can use Microsoft Entra ID features with NetBird — su

## Next Steps

Once admin consent is granted, you can configure Entra ID integration with NetBird:
To configure user and group provisioning, follow the guide for your integration:

- [Provision Users & Groups via API](/manage/team/idp-sync/microsoft-entra-id-sync)
- [Provision Users & Groups via SCIM](/manage/team/idp-sync/microsoft-entra-id-scim-sync)
Original file line number Diff line number Diff line change
Expand Up @@ -33,12 +33,16 @@ This will open a pop-up window featuring a user-friendly wizard, guiding you thr
## Prerequisites

Before starting the integration process, verify that you have the required permissions in Microsoft Entra ID (Azure AD).
Specifically, you will need an Azure user account with at least one of these roles:
To create and configure the app registration, use an Azure user account with at least one of these roles:

* Application Administrator
* Cloud Application Administrator
* Global Administrator

<Note>
Granting the Microsoft Graph `User.Read.All` and `Group.Read.All` **application permissions** later in this guide requires a **Privileged Role Administrator** or **Global Administrator**. See Microsoft's [admin consent requirements](https://learn.microsoft.com/en-us/entra/identity/enterprise-apps/grant-admin-consent#prerequisites).
</Note>

To check your permissions:

* Log in to the [Azure portal](portal.azure.com).
Expand Down Expand Up @@ -97,7 +101,7 @@ Once done, click the `Add permissions` button. You will see a few warnings:

![The API permissions list with User.Read.All and Group.Read.All showing a Not granted warning next to the Grant admin consent button](/docs-static/img/manage/team/idp-sync/microsoft-entra-id-sync/needed-netbird-api-perms.png)

Locate the `Grant admin consent for [Your Organization Name]` button (you'll find it next to `+Add a permission` button). Click on it to grant the required permissions.
Have a **Privileged Role Administrator** or **Global Administrator** open the app registration's **API permissions** page and click `Grant admin consent for [Your Organization Name]` to grant the required permissions.

A confirmation dialog will appear, asking you to verify this action. Review the permissions listed in the dialog and click `Yes` to confirm. Wait for the process to complete, this may take a few seconds.

Expand Down
2 changes: 2 additions & 0 deletions src/pages/manage/team/idp-sync/google-workspace-sync.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,8 @@ Google Workspace to NetBird. You can utilize these synchronized groups to config
access policies, and automate onboarding and offboarding processes, adding significant value to your organizational
workflow and security posture.

For changes to a user's synced groups to update their peers, [Enable user group propagation](/manage/settings/groups#enable-user-group-propagation) must be enabled in `Settings` > `Groups`. If it is disabled, removing a user from a Google Workspace group leaves their peers' existing group memberships intact. Update those peer memberships manually in NetBird to revoke access granted through that group.

The integration process involves two complementary services: Google Workspace and Google Cloud Platform (GCP).
Google Workspace serves as your Identity Provider (IdP), managing user and group identities and providing Single Sign-On (SSO)
capabilities. GCP is used to create a service account, which NetBird uses to authenticate and access Google Workspace
Expand Down
Loading
Loading