diff --git a/public/docs-static/img/manage/team/single-sign-on/authentik-idp/1-create-with-provider.png b/public/docs-static/img/manage/team/single-sign-on/authentik-idp/1-create-with-provider.png deleted file mode 100644 index 0b6067c0..00000000 Binary files a/public/docs-static/img/manage/team/single-sign-on/authentik-idp/1-create-with-provider.png and /dev/null differ diff --git a/public/docs-static/img/manage/team/single-sign-on/authentik-idp/2-new-application.png b/public/docs-static/img/manage/team/single-sign-on/authentik-idp/2-new-application.png deleted file mode 100644 index 78bf612f..00000000 Binary files a/public/docs-static/img/manage/team/single-sign-on/authentik-idp/2-new-application.png and /dev/null differ diff --git a/public/docs-static/img/manage/team/single-sign-on/authentik-idp/3-new-application-type.png b/public/docs-static/img/manage/team/single-sign-on/authentik-idp/3-new-application-type.png deleted file mode 100644 index b0d3dbdd..00000000 Binary files a/public/docs-static/img/manage/team/single-sign-on/authentik-idp/3-new-application-type.png and /dev/null differ diff --git a/public/docs-static/img/manage/team/single-sign-on/authentik-idp/7-new-application-submit.png b/public/docs-static/img/manage/team/single-sign-on/authentik-idp/7-new-application-submit.png deleted file mode 100644 index df655481..00000000 Binary files a/public/docs-static/img/manage/team/single-sign-on/authentik-idp/7-new-application-submit.png and /dev/null differ diff --git a/public/docs-static/img/manage/team/single-sign-on/authentik-idp/8-list-applications.png b/public/docs-static/img/manage/team/single-sign-on/authentik-idp/8-list-applications.png deleted file mode 100644 index c09f59f5..00000000 Binary files a/public/docs-static/img/manage/team/single-sign-on/authentik-idp/8-list-applications.png and /dev/null differ diff --git a/public/docs-static/img/manage/team/single-sign-on/cidaas-idp/app-created.png b/public/docs-static/img/manage/team/single-sign-on/cidaas-idp/app-created.png deleted file mode 100644 index 2d772c8a..00000000 Binary files a/public/docs-static/img/manage/team/single-sign-on/cidaas-idp/app-created.png and /dev/null differ diff --git a/public/docs-static/img/manage/team/single-sign-on/cidaas-idp/company-settings.png b/public/docs-static/img/manage/team/single-sign-on/cidaas-idp/company-settings.png deleted file mode 100644 index a679644c..00000000 Binary files a/public/docs-static/img/manage/team/single-sign-on/cidaas-idp/company-settings.png and /dev/null differ diff --git a/public/docs-static/img/manage/team/single-sign-on/keycloak-idp/1-new-client.png b/public/docs-static/img/manage/team/single-sign-on/keycloak-idp/1-new-client.png deleted file mode 100644 index c7a2de09..00000000 Binary files a/public/docs-static/img/manage/team/single-sign-on/keycloak-idp/1-new-client.png and /dev/null differ diff --git a/public/docs-static/img/manage/team/single-sign-on/keycloak-idp/2-new-client-type.png b/public/docs-static/img/manage/team/single-sign-on/keycloak-idp/2-new-client-type.png deleted file mode 100644 index b71b24d8..00000000 Binary files a/public/docs-static/img/manage/team/single-sign-on/keycloak-idp/2-new-client-type.png and /dev/null differ diff --git a/public/docs-static/img/manage/team/single-sign-on/zitadel-idp/create-project.png b/public/docs-static/img/manage/team/single-sign-on/zitadel-idp/create-project.png deleted file mode 100644 index ae956bf7..00000000 Binary files a/public/docs-static/img/manage/team/single-sign-on/zitadel-idp/create-project.png and /dev/null differ diff --git a/public/docs-static/img/manage/team/single-sign-on/zitadel-idp/project-created.png b/public/docs-static/img/manage/team/single-sign-on/zitadel-idp/project-created.png deleted file mode 100644 index 30f3a928..00000000 Binary files a/public/docs-static/img/manage/team/single-sign-on/zitadel-idp/project-created.png and /dev/null differ diff --git a/public/docs-static/img/manage/team/single-sign-on/zitadel-idp/review-application.png b/public/docs-static/img/manage/team/single-sign-on/zitadel-idp/review-application.png deleted file mode 100644 index 2906fd52..00000000 Binary files a/public/docs-static/img/manage/team/single-sign-on/zitadel-idp/review-application.png and /dev/null differ diff --git a/src/pages/manage/team/idp-sync/index.mdx b/src/pages/manage/team/idp-sync/index.mdx index b287902e..9d3867b3 100644 --- a/src/pages/manage/team/idp-sync/index.mdx +++ b/src/pages/manage/team/idp-sync/index.mdx @@ -1,7 +1,7 @@ # Provision Users and Groups From Your Identity Provider

- supported-identity-providers

@@ -68,6 +68,6 @@ SCIM is a standardized protocol that works with most modern identity providers, If your provider is not listed above, contact us at support@netbird.io for assistance with your specific IdP setup.

- generic-scim

diff --git a/src/pages/manage/team/single-sign-on/auth0.mdx b/src/pages/manage/team/single-sign-on/auth0.mdx index fb7e315f..ad50a5c7 100644 --- a/src/pages/manage/team/single-sign-on/auth0.mdx +++ b/src/pages/manage/team/single-sign-on/auth0.mdx @@ -11,7 +11,7 @@ You can use Auth0 as your Identity Provider with NetBird, but it will require so 3. Enter **NetBird** as the name, select **Single Page Web Applications** as the application type and click **Create**

- auth0-application-create + The Auth0 Create Application dialog with NetBird entered as the name

4. On the New Application screen, go to the Settings tab and under Application URIs set the following values: @@ -21,7 +21,7 @@ You can use Auth0 as your Identity Provider with NetBird, but it will require so - Allowed Web Origins: https://app.netbird.io

- auth0-application-configure + The Auth0 Application URIs section filled in with the NetBird login, callback, logout, and web origin URLs

6. Record the **Client ID** and **Client Secret** that Auth0 generates for your application. @@ -29,7 +29,7 @@ You can use Auth0 as your Identity Provider with NetBird, but it will require so 7. Retrieve Application's **Domain** from the **Basic Information** tab

- auth0-application-domain + The Auth0 Basic Information tab showing the application Domain

8. Share following with our team. Please use a secure method for sharing the sensitive parts of this information: diff --git a/src/pages/manage/team/single-sign-on/authentik.mdx b/src/pages/manage/team/single-sign-on/authentik.mdx index 03209c03..0abcc99d 100644 --- a/src/pages/manage/team/single-sign-on/authentik.mdx +++ b/src/pages/manage/team/single-sign-on/authentik.mdx @@ -10,61 +10,41 @@ You can use Authentik as your Identity Provider with NetBird, but it will requir 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: + - Browse to the Applications Administration menu, click on Application, and then click on Create with Provider. -

- create-with-provider -

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

- new-application -

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

- new-application -

+ - 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:

- new-application + Authentik provider settings showing the authorization flow, Client ID, and Client Secret

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

- new-application + Authentik redirect URI field set to the NetBird callback URL and a signing key selected

- 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:

- new-application + Authentik advanced protocol settings with openid, email, and profile scopes and Subject mode set to hash ID

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

- new-application -

- - - You should see an application listed as follow: - -

- list-applications -

+ - The new application now appears in the Applications list. 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:

- list-providers + Authentik provider detail page showing the OpenID Configuration URL

- Copy the OpenID Configuration URL. - 3. Then, share the following information with the NetBird support team at support@netbird.io: - Client ID diff --git a/src/pages/manage/team/single-sign-on/aws-cognito.mdx b/src/pages/manage/team/single-sign-on/aws-cognito.mdx index d830b13a..d12149e3 100644 --- a/src/pages/manage/team/single-sign-on/aws-cognito.mdx +++ b/src/pages/manage/team/single-sign-on/aws-cognito.mdx @@ -36,7 +36,7 @@ Fill in the form with the following values: Click **Create app client** to save.

- aws-cognito-app-client + The Amazon Cognito Create app client form with the NetBird client settings

## Step 2: Verify Managed Login Pages Configuration @@ -50,11 +50,11 @@ In the same app client, open the **Login pages** tab, locate the **Managed login

- aws-cognito-callback-urls + The Amazon Cognito login pages settings with the NetBird callback and sign-out URLs

- aws-cognito-oauth-settings + The Amazon Cognito OAuth settings with the authorization code grant and the openid, email, and profile scopes selected

Click **Save changes** to apply the configuration. @@ -75,7 +75,7 @@ https://cognito-idp..amazonaws.com/ For example, a user pool with ID `us-east-1_AbCdEfGhI` in the `us-east-1` region has the issuer URL `https://cognito-idp.us-east-1.amazonaws.com/us-east-1_AbCdEfGhI`. The OIDC discovery document is available at `/.well-known/openid-configuration`.

- aws-cognito-client-credentials + The Amazon Cognito app client page showing the Client ID and Client secret

## Step 4: Share Configuration with NetBird diff --git a/src/pages/manage/team/single-sign-on/cidaas.mdx b/src/pages/manage/team/single-sign-on/cidaas.mdx index 65e9a373..dd9dd64c 100644 --- a/src/pages/manage/team/single-sign-on/cidaas.mdx +++ b/src/pages/manage/team/single-sign-on/cidaas.mdx @@ -24,7 +24,7 @@ Configure the App Details section with the following settings: - **App Type**: `Regular`

- cidaas-app-details + cidaas App Details form with App Type set to Regular

Click **Next** to proceed to App Settings. @@ -39,7 +39,7 @@ Configure the App Settings section with the following settings: - **Allow Logout URLs**: `https://login.netbird.io/oauth/revoke`

- cidaas-app-settings + cidaas App Settings with scopes, OAuth standard, redirect URLs, and logout URLs filled in

Click **Next** to proceed to Company Settings. @@ -54,22 +54,14 @@ Configure the App Settings section with the following settings: - **Privacy Policy URL**: `https://netbird.io/privacy` - **Imprint URL**: `https://netbird.io/imprint` -

- cidaas-company-settings -

- Click **Submit** to create the application. You should see an **App created successfully** confirmation. -

- cidaas-app-created -

- ## Step 5: Verify the Application Status Ensure the application status is set to **Active**. If it is not active, select **Active** from the status dropdown.

- cidaas-app-status + cidaas application status dropdown set to Active

## Step 6: Copy the Client Credentials diff --git a/src/pages/manage/team/single-sign-on/duo-security.mdx b/src/pages/manage/team/single-sign-on/duo-security.mdx index 7e857cea..62479f74 100644 --- a/src/pages/manage/team/single-sign-on/duo-security.mdx +++ b/src/pages/manage/team/single-sign-on/duo-security.mdx @@ -20,7 +20,7 @@ Before you start using Duo Single Sign-On, make sure to meet all the requirement Log in to the [Duo Admin Panel](https://admin.duosecurity.com/). Navigate to **Applications** in the left sidebar, then click **Applications**. Click **+ Add Application** which will open the Application Catalog. Search for **Generic OIDC**, then click **+ Add** next to it.

- duo-select-application + The Duo Application Catalog with Generic OIDC selected

## Step 2: Configure Basic Settings @@ -31,7 +31,7 @@ Configure the Basic Configuration section with the following settings: - **User access**: `Enable for all users` (if applicable to all users) or `Enable only for permitted groups` (for fine-grained access control)

- duo-basic-configuration + The Duo basic configuration form with the application name, type, and user access settings

## Step 3: Configure Relying Party Settings @@ -41,7 +41,7 @@ Configure the Relying Party section with the following settings: - **Sign-In Redirect URLs**: `https://login.netbird.io/login/callback`

- duo-relying-party + The Duo Relying Party settings with the authorization code grant type and the NetBird sign-in redirect URL

## Step 4: Configure OIDC Response @@ -50,7 +50,7 @@ Configure the OIDC Response section with the following scopes: - **Scopes**: openid, profile, email

- duo-oidc-response + The Duo OIDC Response section with the openid, profile, and email scopes selected

Click **Save** to complete the application configuration. diff --git a/src/pages/manage/team/single-sign-on/iij-id.mdx b/src/pages/manage/team/single-sign-on/iij-id.mdx index d3e0cbce..d36a879e 100644 --- a/src/pages/manage/team/single-sign-on/iij-id.mdx +++ b/src/pages/manage/team/single-sign-on/iij-id.mdx @@ -18,7 +18,7 @@ Log in to the IIJ ID console and navigate to `Application` > `Application Manage Select `OpenID Connect Application` and click `Next`.

- iij-id-create-custom-app + The IIJ ID custom application picker with OpenID Connect Application selected

Fill out the application information: @@ -30,7 +30,7 @@ Fill out the application information: Click `Add Application`.

- iij-id-application-information + The IIJ ID application information form filled in for NetBird

## Step 2: Configure the Federation Settings @@ -44,7 +44,7 @@ Open the newly created application, click `Edit`, and select the `Federation` ta Click `Update` to apply the configuration.

- iij-id-federation-settings + The IIJ ID federation settings with the NetBird redirect URI and OIDC options

## Step 3: Retrieve the Client Credentials @@ -62,7 +62,7 @@ NetBird uses the Discovery endpoint to automatically resolve the Authorization, Assign access to the NetBird application so users can sign in to NetBird with IIJ ID. Open the application, select `Application User`, and click `Add Application User`. Select the users or groups that should have access, choose whether the application appears in **My Applications**, and click `Add Application User`.

- iij-id-assign-users + The IIJ ID Application User screen for assigning users and groups to NetBird

## Step 5: Share Configuration with NetBird diff --git a/src/pages/manage/team/single-sign-on/index.mdx b/src/pages/manage/team/single-sign-on/index.mdx index 53b15b02..1af0ae40 100644 --- a/src/pages/manage/team/single-sign-on/index.mdx +++ b/src/pages/manage/team/single-sign-on/index.mdx @@ -21,7 +21,7 @@ If you're using Google Workspace, Microsoft Entra ID, or a supported social logi setup—just click the appropriate button on the [login page](https://app.netbird.io/):

- netbird-login + The NetBird login page with Google, Microsoft, and GitHub sign-in buttons

## Okta diff --git a/src/pages/manage/team/single-sign-on/jumpcloud.mdx b/src/pages/manage/team/single-sign-on/jumpcloud.mdx index c714de20..9a7cd41f 100644 --- a/src/pages/manage/team/single-sign-on/jumpcloud.mdx +++ b/src/pages/manage/team/single-sign-on/jumpcloud.mdx @@ -11,7 +11,7 @@ You can use JumpCloud as your Identity Provider with NetBird, but it will requir 3. Enable Manage Single Sign-On (SSO), select Configure SSO with OIDC and click Next

- jumpcloud + The JumpCloud custom application dialog with Configure SSO with OIDC selected

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. @@ -19,7 +19,7 @@ You can use JumpCloud as your Identity Provider with NetBird, but it will requir 5. Review the application setting and click Configure Application to proceed

- jumpcloud-idp + The JumpCloud application review screen before configuring the application

6. On the New Application screen, go to the SSO tab and under Endpoint Configuration set the following values: diff --git a/src/pages/manage/team/single-sign-on/keycloak.mdx b/src/pages/manage/team/single-sign-on/keycloak.mdx index a4dc9598..17707480 100644 --- a/src/pages/manage/team/single-sign-on/keycloak.mdx +++ b/src/pages/manage/team/single-sign-on/keycloak.mdx @@ -6,22 +6,14 @@ You can use Keycloak as your Identity Provider with NetBird, but it will require 1. You need to create a new client - - Browse to the clients Administration menu and then click in Create client: + - Browse to the Clients section of the Administration console and click Create client. + +2. Set the client type to OpenID Connect and enter any client ID and name for the client. + +3. Click Next. Under Capability config, turn on Client authentication, leave Authorization off, and select only Standard flow under Authentication flow:

- new-client -

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

- new-client -

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

- new-client + Keycloak Capability config with Client authentication on and only Standard flow selected

4. Click Next and fill the following fields: @@ -30,7 +22,7 @@ You can use Keycloak as your Identity Provider with NetBird, but it will require Web origins: `+`

- new-client + Keycloak login settings with the NetBird callback as valid redirect URI and web origins set to plus

5. Click Save. @@ -38,7 +30,7 @@ You can use Keycloak as your Identity Provider with NetBird, but it will require 6. Next we need to retrieve the secret for the client, you can get that in the Credentials tab for the client:

- new-client + Keycloak client Credentials tab showing the client secret

7. Then, share the following information with the NetBird support team at support@netbird.io: diff --git a/src/pages/manage/team/single-sign-on/zitadel.mdx b/src/pages/manage/team/single-sign-on/zitadel.mdx index ae374ec4..3d8cca3b 100644 --- a/src/pages/manage/team/single-sign-on/zitadel.mdx +++ b/src/pages/manage/team/single-sign-on/zitadel.mdx @@ -17,16 +17,8 @@ You can use Zitadel as your Identity Provider with NetBird, but it will require Log in to your Zitadel console at `https://.zitadel.cloud`. Navigate to **Projects** and click **+ Create New Project**. Enter `NetBird` as the project name and click **Continue**. -

- zitadel-create-project -

- You should see the project dashboard once the project is created. -

- zitadel-project-created -

- ## Step 2: Create a New Application Inside your project, click **+ New** to create a new application. Configure the following: @@ -34,7 +26,7 @@ Inside your project, click **+ New** to create a new application. Configure the - **Type**: `Web`

- zitadel-create-application + Zitadel new application form with name NetBird and type Web selected

Click **Continue**. @@ -44,7 +36,7 @@ Click **Continue**. Select **Code** as the authentication method. This enables the Authorization Code flow with a client secret.

- zitadel-authentication-method + Zitadel authentication method selection with Code selected

Click **Continue**. @@ -56,21 +48,17 @@ Set the following redirect settings: - **Post Logout URIs**: `https://app.netbird.io`

- zitadel-redirect-uris + Zitadel redirect settings with the NetBird callback and post logout URIs

Click **Continue** to proceed to the review stage. Verify your application settings and click **Create**. -

- zitadel-review-application -

- ## Step 5: Copy the Client Credentials After creation, Zitadel displays the **Client ID** and **Client Secret**. Copy and store these securely — the Client Secret is only shown once.

- zitadel-client-credentials + Zitadel showing the generated Client ID and Client Secret

## Step 6: Share Configuration with NetBird diff --git a/src/pages/manage/team/single-sign-on/zoho.mdx b/src/pages/manage/team/single-sign-on/zoho.mdx index 2ae12517..fca619b2 100644 --- a/src/pages/manage/team/single-sign-on/zoho.mdx +++ b/src/pages/manage/team/single-sign-on/zoho.mdx @@ -18,7 +18,7 @@ Log in to [Zoho Directory](https://directory.zoho.com/) and open the **Admin Pan Enter `NetBird` as the application name and an optional description.

- zoho-create-custom-app + The Zoho custom application form with NetBird entered as the application name

## Step 2: Configure the OIDC Application @@ -34,7 +34,7 @@ Under **Relying Party Details**, enter the NetBird endpoints: - **Redirect URL**: `https://login.netbird.io/login/callback`

- zoho-configure-oidc-app + The Zoho OIDC application settings with the NetBird sign-out and redirect URLs

Click **Done**, then **Create**. @@ -49,7 +49,7 @@ Open the newly created application and select the **Single Sign-on** tab. Copy a Under **Optional Endpoints**, copy the **Discovery Endpoint** as well. NetBird uses this single URL to automatically discover the Authorization, Token, and User Info endpoints for your Zoho data center.

- zoho-client-credentials + The Zoho application page showing the Client ID, Client Secret, and Discovery Endpoint

## Step 4: Assign Users @@ -57,7 +57,7 @@ Under **Optional Endpoints**, copy the **Discovery Endpoint** as well. NetBird u Assign access to the NetBird application so users can sign in to NetBird with Zoho. You can assign individual users with **Add User**, or assign entire groups with **Add Group**.

- zoho-assign-users + The Zoho application access screen with the Add User and Add Group buttons

## Step 5: Share Configuration with NetBird