mirror of
https://github.com/netbirdio/docs.git
synced 2026-04-16 07:26:35 +00:00
44 lines
2.3 KiB
Markdown
44 lines
2.3 KiB
Markdown
---
|
|
id: using-netbird-with-auth0
|
|
title: Using NetBird with Auth0
|
|
sidebar_position: 2
|
|
tags:
|
|
- integrations
|
|
- idp
|
|
- auth0
|
|
- oidc
|
|
- how-to
|
|
---
|
|
|
|
This guide is a part of the [NetBird Self-hosting Guide](/getting-started/self-hosting) and explains how to integrate **self-hosted** NetBird with [Auth0](https://auth0.com/).
|
|
|
|
Auth0 is a flexible, drop-in solution to add authentication and authorization services to your applications.
|
|
It is a 3rd party managed service and can't be self-hosted. Auth0 is the right choice if you don't want to manage an Identity Provider (IDP)
|
|
instance on your own.
|
|
|
|
:::tip self-hosted idp
|
|
If you prefer to have full control over authentication and authorization of your NetBird network, there are good
|
|
self-hosted alternatives to the managed Auth0 service like [Keycloak](/integrations/identity-providers/self-hosted/using-netbird-with-keycloak).
|
|
:::
|
|
|
|
### Step 1: Create Auth0 account
|
|
To create an Auth0 account, sign up at [https://auth0.com](https://auth0.com/).
|
|
|
|
### Step 2: Configure Auth0 properties in the setup.env file
|
|
1. Configure ```NETBIRD_AUTH_AUTHORITY``` and ```NETBIRD_AUTH_CLIENT_ID``` properties.
|
|
|
|
* To obtain these, use [Auth0 React SDK Guide](https://auth0.com/docs/quickstart/spa/react/01-login#configure-auth0) up until "Install the Auth0 React SDK".
|
|
|
|
> Use ```https://YOUR DOMAIN``` as ````Allowed Callback URLs````, ```Allowed Logout URLs```, ```Allowed Web Origins``` and ```Allowed Origins (CORS)```
|
|
* use Auth0 Client ID to set `NETBIRD_AUTH_CLIENT_ID` e.g., `LBRMAgqIZ7hvpVCaHpQLCJvTzkYYIXJt`
|
|
* use Auth0 Domain to set `NETBIRD_AUTH_AUTHORITY` to `https://auth0-domain.com/`. Pay attention to the `https://` prefix and the trailing slash `/`
|
|
* :warning: Make sure that `Token Endpoint Authentication Method` is set to `None` in your Auth0 Default Application
|
|
2. Configure ```NETBIRD_AUTH_AUDIENCE``` property.
|
|
|
|
* Check [Auth0 Create An API](https://auth0.com/docs/quickstart/backend/golang#create-an-api) section to obtain AuthAudience.
|
|
* set the property in the ```setup.env``` file.
|
|
3. Set `NETBIRD_USE_AUTH0` to `true`.
|
|
4. Set `NETBIRD_AUTH_SUPPORTED_SCOPES` to `openid profile email api offline_access email_verified`
|
|
|
|
### Step 3: Continue with the self-hosting guide
|
|
You can now continue with the [NetBird Self-hosting Guide](/getting-started/self-hosting#step-3-configure-identity-provider). |