sendnrw/netbird-docs
2
0
Fork 0
mirror of https://github.com/netbirdio/docs.git synced 2026-04-16 15:36:36 +00:00
Code Issues Packages Projects Releases Wiki Activity

Add SSO login docs (#323)

Browse Source 
* Add SSO login docs

* Add SSO login docs
This commit is contained in:
Misha Bragin
2025-05-28 17:24:29 +02:00
committed by GitHub
parent 2a3e25ec94
commit 9fe70b656f
2 changed files with 41 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

45
src/pages/how-to/single-sign-on.mdx
View File

@@ -1,8 +1,45 @@
# Single Sign On
import {Note} from "@/components/mdx";
Please follow the instructions below for your preferred provider.
# Authenticate to NetBird with Single Sign On (SSO)
## Authentik IdP
NetBird works out of the box with popular Identity Providers (IdPs) such as Google Workspace, Microsoft Entra ID, and Okta,
offering seamless Single Sign-On (SSO) for your users.
It also supports social logins including Google, GitHub, and Microsoft accounts.
For other OIDC (OpenID Connect)-compliant IdPs like Authentik, Keycloak, JumpCloud, and others, NetBird provides full support,
though some additional configuration is required to complete the integration.
<Note>
This guide covers the setup for cloud-hosted NetBird. If you are using the self-hosted version, please refer
to the [self-hosted documentation](/selfhosted/identity-providers).
</Note>
## Google, Microsoft, and GitHub
If you're using Google Workspace, Microsoft Entra ID, or a supported social login, you can simply sign in with no extra
setup—just click the appropriate button on the [login page](https://app.netbird.io/):
<p>
<img src="/docs-static/img/how-to-guides/single-sign-on/netbird-login.png" alt="netbird-login" className="imagewrapper"/>
</p>
## Okta
If you are using Okta as your Identity Provider, sign up with any email address and then follow the steps described
in [this guide](/how-to/okta-sync#get-started-with-net-bird-okta-integration)
## OIDC-compliant IdPs
For OIDC-compliant Identity Providers such as **Authentik**, **Keycloak**, and others, you’ll need to configure the IdP
to integrate with NetBird. Below are the steps to set up different OIDC-compliant IdPs with NetBird.
<Note>
Support for OIDC-compliant IdPs is available on the Team plan and higher.
The Free plan supports Google, Microsoft, and social logins.
</Note>
### Authentik
1. You need to create a new Application and Provider.
- Browse to the Applications Administration menu, click on Application, and then click on Create with Provider:
@@ -73,7 +110,7 @@ https://onetimesecret.com/en/ <br/>
https://password.link/en
</Note>
## Keycloak IdP
### Keycloak
1. You need to create a new client