sendnrw/netbird-docs
2
0
Fork 0
mirror of https://github.com/netbirdio/docs.git synced 2026-04-19 17:06:36 +00:00
Code Issues Packages Projects Releases Wiki Activity

Okta SCIM sync (#163)

Browse Source 
Co-authored-by: Maycon Santos <mlsmaycon@gmail.com>
Co-authored-by: Misha Bragin <bangvalo@gmail.com>
This commit is contained in:
Bethuel Mmbaga
2024-03-08 18:27:55 +03:00
committed by GitHub
parent a38af80e54
commit 9de4e0a8ca
16 changed files with 307 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

126
src/pages/how-to/idp-sync.mdx
View File

@@ -121,4 +121,128 @@ Before you start creating and configuring an Azure AD application, ensure that y
</p>
- Navigate to [Owner applications](https://portal.azure.com/#view/Microsoft_AAD_IAM/ActiveDirectoryMenuBlade/~/RegisteredApps).
- Select `NetBird` application in overview page, take note of `Application (client) ID` and `Directory (tenant) ID`.
- Select `NetBird` application in overview page, take note of `Application (client) ID` and `Directory (tenant) ID`.
### Okta
#### Step 1. Create and configure SAML 2.0 application
In this step, we will create and configure NetBird SAML 2.0 application in okta.
- Navigate to Okta Admin Dashboard
- Click `Applications` in the left menu and then click on `Applications`
- Click `Create App Integration`
- Fill in the form with the following values and click `Next`
- Sign-in method: `SAML 2.0`
<p>
<img src="/docs-static/img/how-to-guides/okta-new-application.png" alt="high-level-dia" />
</p>
- Fill in the form with the following values and click `Next`
- App integration name: `NetBird SCIM`
<p>
<img src="/docs-static/img/how-to-guides/okta-saml-general-settings.png" alt="high-level-dia" />
</p>
- Fill in the form will the following values and click `Next`
- Single sign-on URL: `http://localhost`
- Audience URI (SP Entity ID): `http://localhost`
<p>
<img src="/docs-static/img/how-to-guides/okta-saml-configuration.png" alt="high-level-dia" />
</p>
- Select App type as `This is an internal app that we have created` and click `Finish`
<p>
<img src="/docs-static/img/how-to-guides/okta-saml-configuration-feedback.png" alt="high-level-dia" />
</p>
#### Step 2. Create Okta SCIM integration
Refer to the [api.md](https://github.com/netbirdio/docs/blob/main/misc/idp-sync/api.md#okta-scim-endpoints) document for detailed instructions on how to create the integration.
After creating, please take note of the `auth_token` from the response as we will use it in the next step.
#### Step 3. Enable and configure SCIM provisioning
Before proceeding with this step, we need to create
- Navigate to Okta Admin Dashboard
- Click `Applications` in the left menu and then click on `Applications`
- Select the `NetBird SCIM` application we created earlier
<p>
<img src="/docs-static/img/how-to-guides/okta-netbird-app-overview.png" alt="high-level-dia" />
</p>
- Click `General` tab and in `App Settings` click `Edit` to update the settings
- Tick `Enable SCIM provisioning` and click `Save`
<p>
<img src="/docs-static/img/how-to-guides/okta-scim-provisioning-enabled.png" alt="high-level-dia" />
</p>
- Click `Provisioning` and under `SCIM connection` click `Edit`
- Fill in the form will the following values and click `Save`
- SCIM connector base URL: `https://api.netbird.io/api/scim/v2`
- Unique identifier field for users: `userName`
- Supported provisioning actions: `Push New Users`, `Push Profile Updates`, `Push Groups`
- Authentication Mode: `HTTP Header`
- HTTP Header Token you obtained from NetBird : `nbs_zKY09...`
<p>
<img src="/docs-static/img/how-to-guides/okta-scim-provisioning-settings.png" alt="high-level-dia" />
</p>
- Click on `Test Connector Configuration` to verify if the SCIM configuration is working. After the test is completed,
make sure `Create Users`, `Update User Attributes`, and `Push Groups` were successful.
<p>
<img src="/docs-static/img/how-to-guides/okta-connector-configuration-test.png" alt="high-level-dia" />
</p>
- Click `Save` and then click `Provisioning` tab
<p>
<img src="/docs-static/img/how-to-guides/okta-scim-to-app-configuration.png" alt="high-level-dia" />
</p>
- Go to the `Provisioning` tab, and select the `To App` settings and click `Edit`
- Enable `Create Users`, `Update User Attributes`, and `Deactivate Users` and click `Save`
<p>
<img src="/docs-static/img/how-to-guides/okta-scim-to-app-sync-enabled.png" alt="high-level-dia" />
</p>
#### Step 4. Assign groups to application and push to NetBird
This step will cover how to provision user sync using groups and push them to NetBird. If you are interested in managing single user
access without using the groups, you can learn how to do it [here](https://help.okta.com/en-us/content/topics/users-groups-profiles/usgp-assign-apps.htm).
- Go to the `Assignments` tab.
<p>
<img src="/docs-static/img/how-to-guides/okta-groups-assignments.png" alt="high-level-dia" />
</p>
- Select the `Assign` and then click `Assign to Groups`
- Select the groups you want to provision, and then select `Assign` and click `Save and Go Back`.
- Select `Done` after you've finished assigning groups.
At this point, all members of the groups assigned to the application will be synced to NetBird.
- Go to the `Push Groups` tab
<p>
<img src="/docs-static/img/how-to-guides/okta-sync-groups.png" alt="high-level-dia" />
</p>
- Select the `Push Groups` and then click `Find groups by name`
- Search groups to push and then click `Save`
<p>
<img src="/docs-static/img/how-to-guides/okta-push-group-assignment.png" alt="high-level-dia" />
</p>
- The selected groups will then be synced to NetBird.
<p>
<img src="/docs-static/img/how-to-guides/okta-group-push-status.png" alt="high-level-dia" />
</p>