Add optional logout URL step (#775)

This commit is contained in:
Brandon Hopkins
2026-06-03 07:42:33 -07:00
committed by GitHub
parent e49d920fb6
commit d7d9e75e5b
12 changed files with 24 additions and 0 deletions

View File

@@ -128,6 +128,8 @@ Write-Host "Client Secret: $($serverApp.ClientSecret)"
Record both the **Client ID** and **Client Secret**. You will paste them into the NetBird dashboard in Step 2.
*(Optional)* To let logout redirect back to NetBird, register NetBird's logout callback as an additional redirect URI — include `"https://<NETBIRD_FQDN>/oauth2/logout/callback"` in the `-RedirectUri` array above. ADFS validates the `post_logout_redirect_uri` against the registered redirect URIs.
### 1.3 Add a Web API
The Web API resource shares the same identifier as the Server Application so the permission grant in Step 1.4 binds them together.

View File

@@ -94,6 +94,7 @@ Add Authentik as an external IdP directly in the NetBird Management Dashboard. T
</p>
3. Under **Redirect URIs/Origins**, add the redirect URL you copied from NetBird
- *(Optional)* Add a second **Strict** entry, `https://netbird.example.com/oauth2/logout/callback` (replace `netbird.example.com` with your NetBird dashboard domain), so logout redirects back to NetBird cleanly. Authentik validates post-logout redirects against this same allowlist.
4. Select **Strict** (not Regex) to match the exact URL from NetBird
<p>

View File

@@ -143,6 +143,11 @@ The redirect URL format is typically:
https://your-netbird-domain.com/oauth2/callback/{connector-id}
```
**(Optional) Logout redirect URI** — if your provider supports a post-logout (sign-out) redirect URI, also register NetBird's logout callback so logout redirects back to NetBird cleanly:
```
https://your-netbird-domain.com/oauth2/logout/callback
```
<Note>
**Common issues:** Ensure the redirect URI matches exactly - no trailing slashes, correct protocol (https), and proper case sensitivity depending on your provider.
</Note>

View File

@@ -110,6 +110,7 @@ Add Keycloak as an external IdP directly in the NetBird Management Dashboard. Th
1. Return to the Keycloak Admin Console tab
2. On the Login settings page:
- Under **Valid redirect URIs**, paste the redirect URL you copied from NetBird
- *(Optional)* Under **Valid post logout redirect URIs**, add `https://netbird.example.com/oauth2/logout/callback` (replace `netbird.example.com` with your NetBird dashboard domain) so logout redirects back to NetBird cleanly
3. Click **Save**
4. Go to the **Credentials** tab and copy the **Client secret** — you'll need this for Step 6

View File

@@ -55,6 +55,7 @@ Add Auth0 as an external IdP directly in the NetBird Management Dashboard. This
1. Return to the Auth0 tab
2. Go to **Settings** tab
3. Under **Allowed Callback URLs**, add the redirect URL you copied from NetBird
- *(Optional)* Under **Allowed Logout URLs**, add `https://netbird.example.com/oauth2/logout/callback` (replace `netbird.example.com` with your NetBird dashboard domain) so logout redirects back to NetBird cleanly
4. Click **Save Changes**
<p>

View File

@@ -78,6 +78,10 @@ Add Duo as an external IdP directly in the NetBird Management Dashboard. This is
<img src="/docs-static/img/selfhosted/identity-providers/managed/duo/5_redirect-urls.png" alt="Configure Redirect URLs" className="imagewrapper-big"/>
</p>
<Note>
Duo SSO's generic OIDC relying party only exposes **Sign-In Redirect URLs** — there is no separate logout/sign-out redirect field, so no logout URL needs to be configured here.
</Note>
4. Under **Scopes**, ensure the following are enabled:
- **openid** (required, cannot be disabled)
- **profile** (check the box)

View File

@@ -67,6 +67,11 @@ Add Google as an external IdP directly in the NetBird Management Dashboard. This
</p>
4. Click **Create**
<Note>
Google's OAuth 2.0 client only supports **Authorized redirect URIs** — it has no separate logout/sign-out redirect field, so there is no logout URL to configure here.
</Note>
5. Note the **Client ID** and **Client Secret** — you'll need these for Step 4
<p>

View File

@@ -83,6 +83,7 @@ Sometimes, the JumpCloud application configuration will add duplicate attributes
1. Return to the JumpCloud tab
2. Click the **SSO** tab
3. Under **Redirect URIs**, verify the redirect URL matches the exact URL you copied from NetBird (e.g., `https://netbird.hopkins.sh/oauth2/callback`). If it doesn't match exactly, update it to match.
- *(Optional)* In the **Post Logout Redirect URIs** field, add `https://<your-netbird-domain>/oauth2/logout/callback` (using the same domain as the redirect URL) so logout redirects back to NetBird cleanly
4. Click **Save** (if you made any changes)
<p>

View File

@@ -87,6 +87,7 @@ Add Microsoft as an external IdP directly in the NetBird Management Dashboard. C
2. Click **Add a platform** → **Web**
3. In the dropdown next to the redirect URI field, select **Web**
4. Paste the redirect URL you copied from NetBird in the **Redirect URI** field
- *(Optional)* Add NetBird's logout callback as an additional **Web** redirect URI: `https://netbird.example.com/oauth2/logout/callback` (replace `netbird.example.com` with your NetBird dashboard domain). Entra validates the post-logout redirect against the registered redirect URIs, so this lets logout return to NetBird cleanly.
<p>
<img src="/docs-static/img/selfhosted/identity-providers/managed/microsoft-entra-id/3_select-web-paste-uri-microsoft-entra.png" alt="Select web and paste URI" className="imagewrapper-big"/>

View File

@@ -72,6 +72,7 @@ Add Okta as an external IdP directly in the NetBird Management Dashboard. This i
1. Return to the Okta tab
2. In the **Sign-in redirect URIs** field, paste the redirect URL you copied from NetBird
- *(Optional)* In the **Sign-out redirect URIs** field, add `https://netbird.example.com/oauth2/logout/callback` (replace `netbird.example.com` with your NetBird dashboard domain) so logout redirects back to NetBird cleanly
<p>
<img src="/docs-static/img/selfhosted/identity-providers/managed/okta/5_sign-in-uri-okta.png" alt="Sign-in redirect URIs" className="imagewrapper-big"/>

View File

@@ -80,6 +80,7 @@ After saving, NetBird displays the **Redirect URL**. Copy this URL and add it to
1. Return to PocketID console → **OIDC Clients**
2. Edit your NetBird client
3. Add the redirect URL to **Callback URLs**
- *(Optional)* In **Logout Callback URLs**, add `https://netbird.example.com/oauth2/logout/callback` (replace `netbird.example.com` with your NetBird dashboard domain) so logout redirects back to NetBird cleanly
<p>
<img src="/docs-static/img/selfhosted/identity-providers/self-hosted/pocketid/6_add-callback-url-pocketid.png" alt="Add callback URL" className="imagewrapper-big"/>

View File

@@ -87,6 +87,7 @@ Add Zitadel as an external IdP directly in the NetBird Management Dashboard. Thi
1. Return to the Zitadel Console tab
2. In the redirect URIs field, paste the redirect URL you copied from NetBird
- *(Optional)* In the **Post Logout URIs** field, add `https://netbird.example.com/oauth2/logout/callback` (replace `netbird.example.com` with your NetBird dashboard domain) so logout redirects back to NetBird cleanly
<p>
<img src="/docs-static/img/selfhosted/identity-providers/self-hosted/zitadel/07_add_redirect-uri-zitadel.png" alt="Add redirect URI" className="imagewrapper-big"/>