Authenticate to NetBird with Single Sign On (SSO)

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.

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:

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

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.

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:

• Name the Application and select a suitable explicit user flow. In the example below, we used NetBird:

• Click Next and select the OAuth2/OpenID Provider Type:

• Click Next and select an explicit user authorization flow, then take note of the Client ID and Client Secret:

• Add the following redirect URL and select a signing key:
  URL: https://login.netbird.io/login/callback

• Click on Advanced protocol settings and ensure that the email, opened, and profile scopes are selected and that Based on the User’s Hash ID is selected for Subject mode:

• Click Next on the following two screens and Submit to create the provider and application:

• You should see an application listed as follow:

2. We need to copy the OpenID Configuration URL for the new provider. You can do that by navigating to Providers in the left menu and then selecting the newly created provider. There you should see a windows similar to the following:

• Copy the OpenID Configuration URL.

3. Then, share the following information with the NetBird support team at support@netbird.io:

• Client ID
• Client Secret
• OpenID Configuration URL
• Email domains for your users

Keycloak

1. You need to create a new client

   • Browse to the clients Administration menu and then click in Create client:

2. Create a client with the type OpenID Connect and add any client ID and name for the client:

3. Click Next and enable the following options for Capability config:

4. Click Next and fill the following fields:

   Valid redirect URIs: https://login.netbird.io/login/callback
   Web origins: +

5. Click Save.

6. Next we need to retrieve the secret for the client, you can get that in the Credentials tab for the client:

7. Then, share the following information with the NetBird support team at support@netbird.io:

• Client ID
• Keycloak URL
• Realm
• Client Secret
• Email domains for your users

JumpCloud

1. Access the JumpCloud and navigate to USER AUTHENTICATION > SSO Applications

2. Click + Add New Application, select Custom Application and click Next

3. Enable Manage Single Sign-On (SSO), select Configure SSO with OIDC and click Next

4. Add NetBird as Display Label and click Next. Optionally, you can enter a Description, adjust the User Portal Image and choose to hide or Show in User Portal.

5. Review the application setting and click Configure Application to proceed

6. On the New Application screen, go to the SSO tab and under Endpoint Configuration set the following values:

• Redirect URIs: https://login.netbird.io/login/callback

• Login URL: https://app.netbird.io

7. Under Attribute Mapping enable Email and Profile scopes

8. Go to the User Groups and select the list of groups to which you want to give access to the application and then click activate

9. Record the Client ID and Client Secret that JumpCloud generates for your application.

10. Share your Client ID, and Client Secret with our team. Please use a secure method for sharing this information.