Revise and simplify IdP Sync setup documentation (#131)

This commit is contained in:
Bethuel Mmbaga
2024-01-17 17:47:13 +03:00
committed by GitHub
parent c1aa6739df
commit 87e607ba67
7 changed files with 6 additions and 44 deletions

Binary file not shown.

Before

Width:  |  Height:  |  Size: 176 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 196 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 188 KiB

View File

Before

Width:  |  Height:  |  Size: 171 KiB

After

Width:  |  Height:  |  Size: 171 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 118 KiB

After

Width:  |  Height:  |  Size: 117 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 182 KiB

View File

@@ -1,3 +1,5 @@
export const title = 'IdP Sync'
## IdP sync ## IdP sync
Welcome to our comprehensive guide on configuring Identity Provider (IdP) for users and groups synchronization. This document provides step-by-step instructions and best practices for setting up and managing your synchronization processes effectively. Welcome to our comprehensive guide on configuring Identity Provider (IdP) for users and groups synchronization. This document provides step-by-step instructions and best practices for setting up and managing your synchronization processes effectively.
@@ -81,48 +83,13 @@ Before you start creating and configuring an Azure AD application, ensure that y
- Click `App Registrations` in the left menu then click on the `+ New registration` button to create a new application. - Click `App Registrations` in the left menu then click on the `+ New registration` button to create a new application.
- Fill in the form with the following values and click `Register` - Fill in the form with the following values and click `Register`
- Name: `NetBird` - Name: `NetBird`
- Account Types: `Accounts in this organizational directory only (Default Directory only - Single tenant)`
- Redirect URI: select `Single-page application (SPA)` and URI as `https://app.netbird.io/silent-auth`
<p> <p>
<img src="/docs-static/img/how-to-guides/azure-new-application.png" alt="azure-new-application"/> <img src="/docs-static/img/how-to-guides/azure-new-application.png" alt="azure-new-application"/>
</p> </p>
#### Step 2. Platform configurations #### Step 2. Add API permissions
- Click `Authentication` on the left side menu
- Under the `Single-page application` Section, add another URI `https://app.netbird.io/auth` and click `Save`
<p>
<img src="/docs-static/img/how-to-guides/azure-spa-uri-setup.png" alt="azure-spa-uri-setup" />
</p>
#### Step 3. Create a NetBird application scope
- Click `Expose an API` on the left menu
- In `Application ID URI` click `Add` and then `Save`
<p>
<img src="/docs-static/img/how-to-guides/azure-add-application-uri.png" alt="azure-add-application-uri" />
</p>
- Under `Scopes defined by this API` click `+ Add a Scope`
- Fill in the form with the following values and click `Add scope`
- Scope name: `api`
- State: `Enabled`
<p>
<img src="/docs-static/img/how-to-guides/azure-add-scope.png" alt="azure-add-scope" />
</p>
- Under `Authorized client Applications`, click on `+ add a client application` and enter the following:
- Fill in the form with the following values and click `Add application`
- Client ID: same as your Application ID URI minus the `api://`
<p>
<img src="/docs-static/img/how-to-guides/azure-authorize-application.png" alt="azure-authorize-application" />
</p>
#### Step 4. Add API permissions
- Click `API permissions` on the left menu - Click `API permissions` on the left menu
- Click `Add a permission` - Click `Add a permission`
@@ -133,18 +100,13 @@ Before you start creating and configuring an Azure AD application, ensure that y
<img src="/docs-static/img/how-to-guides/azure-openid-permissions.png" alt="azure-openid-permissions" /> <img src="/docs-static/img/how-to-guides/azure-openid-permissions.png" alt="azure-openid-permissions" />
</p> </p>
- Click `Grant admin conset for Default Directory` and click `Yes` - Click `Grant admin consent for Default Directory` and click `Yes`
<p> <p>
<img src="/docs-static/img/how-to-guides/azure-grant-admin-conset.png" alt="azure-grant-admin-conset"/> <img src="/docs-static/img/how-to-guides/azure-grant-admin-consent.png" alt="azure-grant-admin-consent"/>
</p> </p>
#### Step 5. Update token version #### Step 3. Generate client secret
- Click `Manifest` on left menu
- Search for `accessTokenAcceptedVersion` and change the value from `null` to `2`
- Click `Save`
#### Step 6. Generate client secret
- Click `Certificates & secrets` on left menu - Click `Certificates & secrets` on left menu
- Click `New client secret` - Click `New client secret`
- Fill in the form with the following values and click `Add` - Fill in the form with the following values and click `Add`