Trim SSO walkthrough screenshots and fix alt text (#983)
|
Before Width: | Height: | Size: 46 KiB |
|
Before Width: | Height: | Size: 53 KiB |
|
Before Width: | Height: | Size: 81 KiB |
|
Before Width: | Height: | Size: 47 KiB |
|
Before Width: | Height: | Size: 37 KiB |
|
Before Width: | Height: | Size: 130 KiB |
|
Before Width: | Height: | Size: 113 KiB |
|
Before Width: | Height: | Size: 26 KiB |
|
Before Width: | Height: | Size: 49 KiB |
|
Before Width: | Height: | Size: 87 KiB |
|
Before Width: | Height: | Size: 336 KiB |
|
Before Width: | Height: | Size: 243 KiB |
@@ -1,7 +1,7 @@
|
||||
# Provision Users and Groups From Your Identity Provider
|
||||
|
||||
<p>
|
||||
<img src="/docs-static/img/manage/team/idp-sync/supported-identity-providers.png" alt="supported-identity-providers"
|
||||
<img src="/docs-static/img/manage/team/idp-sync/supported-identity-providers.png" alt="The Identity Provider Sync tab showing a card for each supported provider"
|
||||
className="imagewrapper-big"/>
|
||||
</p>
|
||||
|
||||
@@ -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.
|
||||
|
||||
<p>
|
||||
<img src="/docs-static/img/manage/team/idp-sync/generic-scim.png" alt="generic-scim"
|
||||
<img src="/docs-static/img/manage/team/idp-sync/generic-scim.png" alt="The Generic SCIM setup dialog in the NetBird dashboard"
|
||||
className="imagewrapper-big"/>
|
||||
</p>
|
||||
|
||||
@@ -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**
|
||||
|
||||
<p>
|
||||
<img src="/docs-static/img/manage/team/single-sign-on/auth0-idp/application-create.png" alt="auth0-application-create" className="imagewrapper-big"/>
|
||||
<img src="/docs-static/img/manage/team/single-sign-on/auth0-idp/application-create.png" alt="The Auth0 Create Application dialog with NetBird entered as the name" className="imagewrapper-big"/>
|
||||
</p>
|
||||
|
||||
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
|
||||
|
||||
<p>
|
||||
<img src="/docs-static/img/manage/team/single-sign-on/auth0-idp/application-configure.png" alt="auth0-application-configure" className="imagewrapper-big"/>
|
||||
<img src="/docs-static/img/manage/team/single-sign-on/auth0-idp/application-configure.png" alt="The Auth0 Application URIs section filled in with the NetBird login, callback, logout, and web origin URLs" className="imagewrapper-big"/>
|
||||
</p>
|
||||
|
||||
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
|
||||
|
||||
<p>
|
||||
<img src="/docs-static/img/manage/team/single-sign-on/auth0-idp/application-domain.png" alt="auth0-application-domain" className="imagewrapper-big"/>
|
||||
<img src="/docs-static/img/manage/team/single-sign-on/auth0-idp/application-domain.png" alt="The Auth0 Basic Information tab showing the application Domain" className="imagewrapper-big"/>
|
||||
</p>
|
||||
|
||||
8. Share following with our team. Please use a secure method for sharing the sensitive parts of this information:
|
||||
|
||||
@@ -10,61 +10,41 @@ You can use Authentik as your Identity Provider with NetBird, but it will requir
|
||||
</Note>
|
||||
|
||||
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.
|
||||
|
||||
<p>
|
||||
<img src="/docs-static/img/manage/team/single-sign-on/authentik-idp/1-create-with-provider.png" alt="create-with-provider" className="imagewrapper-big"/>
|
||||
</p>
|
||||
- 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.
|
||||
|
||||
<p>
|
||||
<img src="/docs-static/img/manage/team/single-sign-on/authentik-idp/2-new-application.png" alt="new-application" className="imagewrapper-big"/>
|
||||
</p>
|
||||
|
||||
- Click Next and select the OAuth2/OpenID Provider Type:
|
||||
|
||||
<p>
|
||||
<img src="/docs-static/img/manage/team/single-sign-on/authentik-idp/3-new-application-type.png" alt="new-application" className="imagewrapper-big"/>
|
||||
</p>
|
||||
- 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:
|
||||
<p>
|
||||
<img src="/docs-static/img/manage/team/single-sign-on/authentik-idp/4-new-application-client-id.png" alt="new-application" className="imagewrapper-big"/>
|
||||
<img src="/docs-static/img/manage/team/single-sign-on/authentik-idp/4-new-application-client-id.png" alt="Authentik provider settings showing the authorization flow, Client ID, and Client Secret" className="imagewrapper-big"/>
|
||||
</p>
|
||||
|
||||
- Add the following redirect URL and select a signing key: <br/>
|
||||
URL: `https://login.netbird.io/login/callback`
|
||||
<p>
|
||||
<img src="/docs-static/img/manage/team/single-sign-on/authentik-idp/5-new-application-sign.png" alt="new-application" className="imagewrapper-big"/>
|
||||
<img src="/docs-static/img/manage/team/single-sign-on/authentik-idp/5-new-application-sign.png" alt="Authentik redirect URI field set to the NetBird callback URL and a signing key selected" className="imagewrapper-big"/>
|
||||
</p>
|
||||
|
||||
- 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:
|
||||
|
||||
<p>
|
||||
<img src="/docs-static/img/manage/team/single-sign-on/authentik-idp/6-new-application-scopes.png" alt="new-application" className="imagewrapper-big"/>
|
||||
<img src="/docs-static/img/manage/team/single-sign-on/authentik-idp/6-new-application-scopes.png" alt="Authentik advanced protocol settings with openid, email, and profile scopes and Subject mode set to hash ID" className="imagewrapper-big"/>
|
||||
</p>
|
||||
|
||||
- Click Next on the following two screens and Submit to create the provider and application:
|
||||
|
||||
<p>
|
||||
<img src="/docs-static/img/manage/team/single-sign-on/authentik-idp/7-new-application-submit.png" alt="new-application" className="imagewrapper-big"/>
|
||||
</p>
|
||||
|
||||
- You should see an application listed as follow:
|
||||
|
||||
<p>
|
||||
<img src="/docs-static/img/manage/team/single-sign-on/authentik-idp/8-list-applications.png" alt="list-applications" className="imagewrapper-big"/>
|
||||
</p>
|
||||
- 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:
|
||||
|
||||
<p>
|
||||
<img src="/docs-static/img/manage/team/single-sign-on/authentik-idp/9-list-providers.png" alt="list-providers" className="imagewrapper-big"/>
|
||||
<img src="/docs-static/img/manage/team/single-sign-on/authentik-idp/9-list-providers.png" alt="Authentik provider detail page showing the OpenID Configuration URL" className="imagewrapper-big"/>
|
||||
</p>
|
||||
|
||||
- Copy the OpenID Configuration URL.
|
||||
|
||||
|
||||
3. Then, share the following information with the NetBird support team at support@netbird.io:
|
||||
|
||||
- Client ID
|
||||
|
||||
@@ -36,7 +36,7 @@ Fill in the form with the following values:
|
||||
Click **Create app client** to save.
|
||||
|
||||
<p>
|
||||
<img src="/docs-static/img/manage/team/single-sign-on/aws-cognito-idp/app-client.png" alt="aws-cognito-app-client" className="imagewrapper-big"/>
|
||||
<img src="/docs-static/img/manage/team/single-sign-on/aws-cognito-idp/app-client.png" alt="The Amazon Cognito Create app client form with the NetBird client settings" className="imagewrapper-big"/>
|
||||
</p>
|
||||
|
||||
## 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
|
||||
|
||||
|
||||
<p>
|
||||
<img src="/docs-static/img/manage/team/single-sign-on/aws-cognito-idp/callback-urls.png" alt="aws-cognito-callback-urls" className="imagewrapper-big"/>
|
||||
<img src="/docs-static/img/manage/team/single-sign-on/aws-cognito-idp/callback-urls.png" alt="The Amazon Cognito login pages settings with the NetBird callback and sign-out URLs" className="imagewrapper-big"/>
|
||||
</p>
|
||||
|
||||
<p>
|
||||
<img src="/docs-static/img/manage/team/single-sign-on/aws-cognito-idp/oauth-settings.png" alt="aws-cognito-oauth-settings" className="imagewrapper-big"/>
|
||||
<img src="/docs-static/img/manage/team/single-sign-on/aws-cognito-idp/oauth-settings.png" alt="The Amazon Cognito OAuth settings with the authorization code grant and the openid, email, and profile scopes selected" className="imagewrapper-big"/>
|
||||
</p>
|
||||
|
||||
Click **Save changes** to apply the configuration.
|
||||
@@ -75,7 +75,7 @@ https://cognito-idp.<region>.amazonaws.com/<user-pool-id>
|
||||
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 `<issuer-url>/.well-known/openid-configuration`.
|
||||
|
||||
<p>
|
||||
<img src="/docs-static/img/manage/team/single-sign-on/aws-cognito-idp/client-credentials.png" alt="aws-cognito-client-credentials" className="imagewrapper-big"/>
|
||||
<img src="/docs-static/img/manage/team/single-sign-on/aws-cognito-idp/client-credentials.png" alt="The Amazon Cognito app client page showing the Client ID and Client secret" className="imagewrapper-big"/>
|
||||
</p>
|
||||
|
||||
## Step 4: Share Configuration with NetBird
|
||||
|
||||
@@ -24,7 +24,7 @@ Configure the App Details section with the following settings:
|
||||
- **App Type**: `Regular`
|
||||
|
||||
<p>
|
||||
<img src="/docs-static/img/manage/team/single-sign-on/cidaas-idp/app-details.png" alt="cidaas-app-details" className="imagewrapper-big"/>
|
||||
<img src="/docs-static/img/manage/team/single-sign-on/cidaas-idp/app-details.png" alt="cidaas App Details form with App Type set to Regular" className="imagewrapper-big"/>
|
||||
</p>
|
||||
|
||||
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`
|
||||
|
||||
<p>
|
||||
<img src="/docs-static/img/manage/team/single-sign-on/cidaas-idp/app-settings.png" alt="cidaas-app-settings" className="imagewrapper-big"/>
|
||||
<img src="/docs-static/img/manage/team/single-sign-on/cidaas-idp/app-settings.png" alt="cidaas App Settings with scopes, OAuth standard, redirect URLs, and logout URLs filled in" className="imagewrapper-big"/>
|
||||
</p>
|
||||
|
||||
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`
|
||||
|
||||
<p>
|
||||
<img src="/docs-static/img/manage/team/single-sign-on/cidaas-idp/company-settings.png" alt="cidaas-company-settings" className="imagewrapper-big"/>
|
||||
</p>
|
||||
|
||||
Click **Submit** to create the application. You should see an **App created successfully** confirmation.
|
||||
|
||||
<p>
|
||||
<img src="/docs-static/img/manage/team/single-sign-on/cidaas-idp/app-created.png" alt="cidaas-app-created" className="imagewrapper-big"/>
|
||||
</p>
|
||||
|
||||
## 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.
|
||||
|
||||
<p>
|
||||
<img src="/docs-static/img/manage/team/single-sign-on/cidaas-idp/app-status.png" alt="cidaas-app-status" className="imagewrapper-big"/>
|
||||
<img src="/docs-static/img/manage/team/single-sign-on/cidaas-idp/app-status.png" alt="cidaas application status dropdown set to Active" className="imagewrapper-big"/>
|
||||
</p>
|
||||
|
||||
## Step 6: Copy the Client Credentials
|
||||
|
||||
@@ -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.
|
||||
|
||||
<p>
|
||||
<img src="/docs-static/img/manage/team/single-sign-on/duo-idp/duo-select-application.png" alt="duo-select-application" className="imagewrapper-big"/>
|
||||
<img src="/docs-static/img/manage/team/single-sign-on/duo-idp/duo-select-application.png" alt="The Duo Application Catalog with Generic OIDC selected" className="imagewrapper-big"/>
|
||||
</p>
|
||||
|
||||
## 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)
|
||||
|
||||
<p>
|
||||
<img src="/docs-static/img/manage/team/single-sign-on/duo-idp/duo-basic-configuration.png" alt="duo-basic-configuration" className="imagewrapper-big"/>
|
||||
<img src="/docs-static/img/manage/team/single-sign-on/duo-idp/duo-basic-configuration.png" alt="The Duo basic configuration form with the application name, type, and user access settings" className="imagewrapper-big"/>
|
||||
</p>
|
||||
|
||||
## 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`
|
||||
|
||||
<p>
|
||||
<img src="/docs-static/img/manage/team/single-sign-on/duo-idp/duo-relying-party.png" alt="duo-relying-party" className="imagewrapper-big"/>
|
||||
<img src="/docs-static/img/manage/team/single-sign-on/duo-idp/duo-relying-party.png" alt="The Duo Relying Party settings with the authorization code grant type and the NetBird sign-in redirect URL" className="imagewrapper-big"/>
|
||||
</p>
|
||||
|
||||
## Step 4: Configure OIDC Response
|
||||
@@ -50,7 +50,7 @@ Configure the OIDC Response section with the following scopes:
|
||||
- **Scopes**: openid, profile, email
|
||||
|
||||
<p>
|
||||
<img src="/docs-static/img/manage/team/single-sign-on/duo-idp/duo-oidc-response.png" alt="duo-oidc-response" className="imagewrapper-big"/>
|
||||
<img src="/docs-static/img/manage/team/single-sign-on/duo-idp/duo-oidc-response.png" alt="The Duo OIDC Response section with the openid, profile, and email scopes selected" className="imagewrapper-big"/>
|
||||
</p>
|
||||
|
||||
Click **Save** to complete the application configuration.
|
||||
|
||||
@@ -18,7 +18,7 @@ Log in to the IIJ ID console and navigate to `Application` > `Application Manage
|
||||
Select `OpenID Connect Application` and click `Next`.
|
||||
|
||||
<p>
|
||||
<img src="/docs-static/img/manage/team/single-sign-on/iij-id-idp/create-custom-app.png" alt="iij-id-create-custom-app" className="imagewrapper-big"/>
|
||||
<img src="/docs-static/img/manage/team/single-sign-on/iij-id-idp/create-custom-app.png" alt="The IIJ ID custom application picker with OpenID Connect Application selected" className="imagewrapper-big"/>
|
||||
</p>
|
||||
|
||||
Fill out the application information:
|
||||
@@ -30,7 +30,7 @@ Fill out the application information:
|
||||
Click `Add Application`.
|
||||
|
||||
<p>
|
||||
<img src="/docs-static/img/manage/team/single-sign-on/iij-id-idp/application-information.png" alt="iij-id-application-information" className="imagewrapper-big"/>
|
||||
<img src="/docs-static/img/manage/team/single-sign-on/iij-id-idp/application-information.png" alt="The IIJ ID application information form filled in for NetBird" className="imagewrapper-big"/>
|
||||
</p>
|
||||
|
||||
## 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.
|
||||
|
||||
<p>
|
||||
<img src="/docs-static/img/manage/team/single-sign-on/iij-id-idp/federation-settings.png" alt="iij-id-federation-settings" className="imagewrapper-big"/>
|
||||
<img src="/docs-static/img/manage/team/single-sign-on/iij-id-idp/federation-settings.png" alt="The IIJ ID federation settings with the NetBird redirect URI and OIDC options" className="imagewrapper-big"/>
|
||||
</p>
|
||||
|
||||
## 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`.
|
||||
|
||||
<p>
|
||||
<img src="/docs-static/img/manage/team/single-sign-on/iij-id-idp/assign-users.png" alt="iij-id-assign-users" className="imagewrapper-big"/>
|
||||
<img src="/docs-static/img/manage/team/single-sign-on/iij-id-idp/assign-users.png" alt="The IIJ ID Application User screen for assigning users and groups to NetBird" className="imagewrapper-big"/>
|
||||
</p>
|
||||
|
||||
## Step 5: Share Configuration with NetBird
|
||||
|
||||
@@ -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/):
|
||||
|
||||
<p>
|
||||
<img src="/docs-static/img/manage/team/single-sign-on/netbird-login.png" alt="netbird-login" className="imagewrapper"/>
|
||||
<img src="/docs-static/img/manage/team/single-sign-on/netbird-login.png" alt="The NetBird login page with Google, Microsoft, and GitHub sign-in buttons" className="imagewrapper"/>
|
||||
</p>
|
||||
|
||||
## Okta
|
||||
|
||||
@@ -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
|
||||
|
||||
<p>
|
||||
<img src="/docs-static/img/manage/team/single-sign-on/jumpcloud-idp/jumpcloud-sso.png" alt="jumpcloud" className="imagewrapper-big"/>
|
||||
<img src="/docs-static/img/manage/team/single-sign-on/jumpcloud-idp/jumpcloud-sso.png" alt="The JumpCloud custom application dialog with Configure SSO with OIDC selected" className="imagewrapper-big"/>
|
||||
</p>
|
||||
|
||||
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
|
||||
|
||||
<p>
|
||||
<img src="/docs-static/img/manage/team/single-sign-on/jumpcloud-idp/jumpcloud-sso-config.png" alt="jumpcloud-idp" className="imagewrapper-big"/>
|
||||
<img src="/docs-static/img/manage/team/single-sign-on/jumpcloud-idp/jumpcloud-sso-config.png" alt="The JumpCloud application review screen before configuring the application" className="imagewrapper-big"/>
|
||||
</p>
|
||||
|
||||
6. On the New Application screen, go to the SSO tab and under Endpoint Configuration set the following values:
|
||||
|
||||
@@ -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:
|
||||
|
||||
<p>
|
||||
<img src="/docs-static/img/manage/team/single-sign-on/keycloak-idp/1-new-client.png" alt="new-client" className="imagewrapper-big"/>
|
||||
</p>
|
||||
|
||||
2. Create a client with the type OpenID Connect and add any client ID and name for the client:
|
||||
|
||||
<p>
|
||||
<img src="/docs-static/img/manage/team/single-sign-on/keycloak-idp/2-new-client-type.png" alt="new-client" className="imagewrapper-big"/>
|
||||
</p>
|
||||
|
||||
3. Click Next and enable the following options for Capability config:
|
||||
|
||||
<p>
|
||||
<img src="/docs-static/img/manage/team/single-sign-on/keycloak-idp/3-new-client-capability.png" alt="new-client" className="imagewrapper-big"/>
|
||||
<img src="/docs-static/img/manage/team/single-sign-on/keycloak-idp/3-new-client-capability.png" alt="Keycloak Capability config with Client authentication on and only Standard flow selected" className="imagewrapper-big"/>
|
||||
</p>
|
||||
|
||||
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: `+`
|
||||
|
||||
<p>
|
||||
<img src="/docs-static/img/manage/team/single-sign-on/keycloak-idp/4-new-client-callback.png" alt="new-client" className="imagewrapper-big"/>
|
||||
<img src="/docs-static/img/manage/team/single-sign-on/keycloak-idp/4-new-client-callback.png" alt="Keycloak login settings with the NetBird callback as valid redirect URI and web origins set to plus" className="imagewrapper-big"/>
|
||||
</p>
|
||||
|
||||
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:
|
||||
|
||||
<p>
|
||||
<img src="/docs-static/img/manage/team/single-sign-on/keycloak-idp/5-new-client-credentials.png" alt="new-client" className="imagewrapper-big"/>
|
||||
<img src="/docs-static/img/manage/team/single-sign-on/keycloak-idp/5-new-client-credentials.png" alt="Keycloak client Credentials tab showing the client secret" className="imagewrapper-big"/>
|
||||
</p>
|
||||
|
||||
7. Then, share the following information with the NetBird support team at support@netbird.io:
|
||||
|
||||
@@ -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://<your-instance>.zitadel.cloud`. Navigate to **Projects** and click **+ Create New Project**. Enter `NetBird` as the project name and click **Continue**.
|
||||
|
||||
<p>
|
||||
<img src="/docs-static/img/manage/team/single-sign-on/zitadel-idp/create-project.png" alt="zitadel-create-project" className="imagewrapper-big"/>
|
||||
</p>
|
||||
|
||||
You should see the project dashboard once the project is created.
|
||||
|
||||
<p>
|
||||
<img src="/docs-static/img/manage/team/single-sign-on/zitadel-idp/project-created.png" alt="zitadel-project-created" className="imagewrapper-big"/>
|
||||
</p>
|
||||
|
||||
## 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`
|
||||
|
||||
<p>
|
||||
<img src="/docs-static/img/manage/team/single-sign-on/zitadel-idp/create-application.png" alt="zitadel-create-application" className="imagewrapper-big"/>
|
||||
<img src="/docs-static/img/manage/team/single-sign-on/zitadel-idp/create-application.png" alt="Zitadel new application form with name NetBird and type Web selected" className="imagewrapper-big"/>
|
||||
</p>
|
||||
|
||||
Click **Continue**.
|
||||
@@ -44,7 +36,7 @@ Click **Continue**.
|
||||
Select **Code** as the authentication method. This enables the Authorization Code flow with a client secret.
|
||||
|
||||
<p>
|
||||
<img src="/docs-static/img/manage/team/single-sign-on/zitadel-idp/authentication-method.png" alt="zitadel-authentication-method" className="imagewrapper-big"/>
|
||||
<img src="/docs-static/img/manage/team/single-sign-on/zitadel-idp/authentication-method.png" alt="Zitadel authentication method selection with Code selected" className="imagewrapper-big"/>
|
||||
</p>
|
||||
|
||||
Click **Continue**.
|
||||
@@ -56,21 +48,17 @@ Set the following redirect settings:
|
||||
- **Post Logout URIs**: `https://app.netbird.io`
|
||||
|
||||
<p>
|
||||
<img src="/docs-static/img/manage/team/single-sign-on/zitadel-idp/redirect-uris.png" alt="zitadel-redirect-uris" className="imagewrapper-big"/>
|
||||
<img src="/docs-static/img/manage/team/single-sign-on/zitadel-idp/redirect-uris.png" alt="Zitadel redirect settings with the NetBird callback and post logout URIs" className="imagewrapper-big"/>
|
||||
</p>
|
||||
|
||||
Click **Continue** to proceed to the review stage. Verify your application settings and click **Create**.
|
||||
|
||||
<p>
|
||||
<img src="/docs-static/img/manage/team/single-sign-on/zitadel-idp/review-application.png" alt="zitadel-review-application" className="imagewrapper-big"/>
|
||||
</p>
|
||||
|
||||
## 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.
|
||||
|
||||
<p>
|
||||
<img src="/docs-static/img/manage/team/single-sign-on/zitadel-idp/client-credentials.png" alt="zitadel-client-credentials" className="imagewrapper-big"/>
|
||||
<img src="/docs-static/img/manage/team/single-sign-on/zitadel-idp/client-credentials.png" alt="Zitadel showing the generated Client ID and Client Secret" className="imagewrapper-big"/>
|
||||
</p>
|
||||
|
||||
## Step 6: Share Configuration with NetBird
|
||||
|
||||
@@ -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.
|
||||
|
||||
<p>
|
||||
<img src="/docs-static/img/manage/team/single-sign-on/zoho-idp/create-custom-app.png" alt="zoho-create-custom-app" className="imagewrapper-big"/>
|
||||
<img src="/docs-static/img/manage/team/single-sign-on/zoho-idp/create-custom-app.png" alt="The Zoho custom application form with NetBird entered as the application name" className="imagewrapper-big"/>
|
||||
</p>
|
||||
|
||||
## 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`
|
||||
|
||||
<p>
|
||||
<img src="/docs-static/img/manage/team/single-sign-on/zoho-idp/configure-oidc-app.png" alt="zoho-configure-oidc-app" className="imagewrapper-big"/>
|
||||
<img src="/docs-static/img/manage/team/single-sign-on/zoho-idp/configure-oidc-app.png" alt="The Zoho OIDC application settings with the NetBird sign-out and redirect URLs" className="imagewrapper-big"/>
|
||||
</p>
|
||||
|
||||
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.
|
||||
|
||||
<p>
|
||||
<img src="/docs-static/img/manage/team/single-sign-on/zoho-idp/client-credentials.png" alt="zoho-client-credentials" className="imagewrapper-big"/>
|
||||
<img src="/docs-static/img/manage/team/single-sign-on/zoho-idp/client-credentials.png" alt="The Zoho application page showing the Client ID, Client Secret, and Discovery Endpoint" className="imagewrapper-big"/>
|
||||
</p>
|
||||
|
||||
## 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**.
|
||||
|
||||
<p>
|
||||
<img src="/docs-static/img/manage/team/single-sign-on/zoho-idp/assign-users.png" alt="zoho-assign-users" className="imagewrapper-big"/>
|
||||
<img src="/docs-static/img/manage/team/single-sign-on/zoho-idp/assign-users.png" alt="The Zoho application access screen with the Add User and Add Group buttons" className="imagewrapper-big"/>
|
||||
</p>
|
||||
|
||||
## Step 5: Share Configuration with NetBird
|
||||
|
||||