-
Notifications
You must be signed in to change notification settings - Fork 49
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
30 changed files
with
186 additions
and
73 deletions.
There are no files selected for viewing
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Oops, something went wrong.
Oops, something went wrong.
Oops, something went wrong.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,107 +1,220 @@ | ||
import { | ||
Note | ||
} from "@/components/mdx"; | ||
|
||
# Provision Users and Groups From Okta | ||
|
||
[Okta](https://www.okta.com/) is a cloud-based identity management service that enables organizations to manage user authentication, | ||
authorization, and access across a wide range of applications and services. | ||
Okta is a cloud-based identity and access management (IAM) platform that centralizes user and customer profiles to enhance | ||
security and streamline access. It offers features like multifactor authentication, single sign-on, and lifecycle | ||
management to help organizations manage user identities effectively. | ||
|
||
NetBird's Okta integration enhances user management by allowing you to utilize Okta as your identity provider. | ||
This integration automates user authentication in your network, adds SSO and MFA support, and simplifies network access management | ||
to your applications and resources. | ||
|
||
Like with [other IdPs](/how-to/idp-sync), NetBird's IdP-Sync feature automates user access management by integrating with Okta and automatically | ||
provisioning users and groups. This integration syncs changes from Okta to NetBird, ensuring that new users receive the | ||
correct network access and that employees leaving the organization have their access immediately revoked. | ||
The integration process consists of two stages: first, you’ll set up OpenID Connect (OIDC) to enable Single Sign-On (SSO) | ||
from NetBird's login page using Okta credentials. Next, you’ll configure SCIM (System for Cross-domain Identity Management) | ||
to synchronize users and groups smoothly. | ||
|
||
## Get Started with NetBird-Okta Integration | ||
|
||
To get started, navigate to [Integrations](https://app.netbird.io/integrations) in the left menu, which will take you to the `Identity Provider` integration. | ||
Click the `Okta` button. This action will trigger a pop-up window that will present you with a user-friendly | ||
wizard, guiding you through the synchronization process between NetBird and Azure AD. | ||
To set up SSO, go to `Integrations` in the NetBird admin console's left menu to access the Identity Provider integration page. Click the `Connect Okta` button to get started with the Okta-NetBird integration. This will open a pop-up window with detailed instructions on synchronizing NetBird and Okta. | ||
|
||
|
||
![NetBird Okta Integration](/docs-static/img/how-to-guides/okta-sync/nwutb3Z.png) | ||
|
||
## Prerequisites | ||
|
||
Before you begin the integration process, ensure you have the [necessary permissions in Okta](https://help.okta.com/en-us/content/topics/security/administrators-admin-comparison.htm). You need an Okta user account with one of the following roles: | ||
|
||
* Super Admin | ||
* Org Admin | ||
* Group Admin | ||
|
||
To check your user permissions in Okta: | ||
|
||
* Log in to your Okta **admin** dashboard. | ||
* Expand `People` in the left menu. | ||
* Select your user. | ||
* Navigate to the `Admin roles` tab. | ||
|
||
Confirm that you have one of the required roles before proceeding with the integration. | ||
|
||
|
||
![Okta Check User Permissions](/docs-static/img/how-to-guides/okta-sync/AGPXpZN.png) | ||
|
||
## Installing the NetBird Integration | ||
|
||
Once you have the necessary permissions, you can set up the NetBird application. First, on NetBird, click `Continue →` to show a summary of the necessary steps. | ||
|
||
|
||
![NetBird Connect NetBird with Okta](/docs-static/img/how-to-guides/okta-sync/dlgCUXo.png) | ||
|
||
Let's go through them one by one: | ||
|
||
* In Okta’s admin dashboard, click `Applications` in the left menu. | ||
* Select `Applications` from the submenu. | ||
* Click the `Browse App Catalog` button. | ||
|
||
|
||
![Okta Browse App Catalog](/docs-static/img/how-to-guides/okta-sync/fkSaYnn.png) | ||
|
||
In the app catalog, enter "NetBird" in the search bar. Then, click the `Add Integration` button. | ||
|
||
|
||
![Okta NetBird App](/docs-static/img/how-to-guides/okta-sync/dgxJ916.png) | ||
|
||
Accept the default application name and click the `Done` button. On the next screen, click the `Assign` dropdown and select `Assign to People`. | ||
|
||
|
||
![Okta Assign People To NetBird App](/docs-static/img/how-to-guides/okta-sync/WQ8O1l7.png) | ||
|
||
You will see a list of users. Find your user account, click `Assign`, and save the changes. Verify your user is assigned to the NetBird app and click `Done`. | ||
|
||
|
||
![Okta Verify User Added To NetBird](/docs-static/img/how-to-guides/okta-sync/bteoM6j.png) | ||
|
||
After that, you will see your user listed in the NetBird application. | ||
|
||
|
||
![Okta User Added To NetBird App](/docs-static/img/how-to-guides/okta-sync/IwaqFvj.png) | ||
|
||
## Configuring SSO in Okta | ||
|
||
The next step is to configure Okta-NetBird SSO integration. | ||
|
||
![NetBird Get Started IdP](/docs-static/img/how-to-guides/okta-sync/okta-sync.png) | ||
In NetBird, click the `Continue →` button. A new wizard screen will appear, offering the instructions for retrieving Okta’s OpenID Connect credentials. You can click `Close` and navigate to Okta. | ||
|
||
If your organization relies on Okta for managing employee access, automating access to NetBird via Okta's `Provisioning` feature can streamline your operations. This integration leverages `SCIM` (System for Cross-domain Identity Management) to ensure smooth synchronization of users and groups. For comprehensive insights into Okta's SCIM capabilities, please consult this [article](https://www.okta.com/blog/2017/01/what-is-scim/). | ||
|
||
#### Prerequisites | ||
- Begin by installing the NetBird application from the [Okta Integration Network](https://www.okta.com/integrations/netbird) | ||
- Following installation, reach out to support to activate Okta SSO for your [support](mailto:[email protected]). | ||
![NetBird Connect NetBird with Okta Sharing Credentials](/docs-static/img/how-to-guides/okta-sync/AYVAbEy.png) | ||
|
||
#### Supported Features | ||
* Click on the `Sign On` tab on Okta. Look for `OpenID Connect` under `Sign on methods` in the `Settings` section. | ||
* Copy the `Client ID` value. | ||
* Copy the `Client Secret` value. | ||
|
||
Store these credentials securely, as you will need them soon. | ||
|
||
##### OIDC Features | ||
- **SP-initiated SSO (Single Sign-On)**: Users must start authentication from NetBird's [login page](https://app.netbird.io/) | ||
by entering their Okta email and clicking `Continue`. | ||
|
||
##### SCIM Features | ||
- **Create Users**: Users added through Okta will automatically be created in NetBird. | ||
- **Update User Attributes**: Any changes to user attributes in Okta will be synchronized with NetBird. | ||
- **Deactivate Users**: Deactivating a user in Okta will also deactivate them in NetBird. | ||
- **Group Push**: Groups created in Okta will be synchronized to NetBird. | ||
![Okta Copy Credentials](/docs-static/img/how-to-guides/okta-sync/rl5Gelc.png) | ||
|
||
#### Configuration Steps | ||
##### Step 1: Configure SSO in Okta | ||
- Access the Okta dashboard and navigate to `Applications > Applications`, selecting the previously installed `NetBird` application. | ||
- Go to `Sign On > Settings` and select `Edit`. | ||
- In the `Credentials Details` section, change the `Application username format` to `Email` and select `Save`. | ||
* Click `Edit` in the `Settings` section. | ||
* In `Credential Details`, change the `Application username format` from `Okta username` to `Email`. | ||
* Click the `Save` button | ||
|
||
<p> | ||
<img src="/docs-static/img/how-to-guides/okta-sso-configuration.png" alt="Okta SSO Configuration" className="imagewrapper-big"/> | ||
</p> | ||
![Okta OpenID Credential Details](/docs-static/img/how-to-guides/okta-sync/FWPf0Cu.png) | ||
|
||
##### Step 2: Enable Okta SCIM in NetBird | ||
- Log into [NetBird](https://app.netbird.io/). | ||
- Proceed to [Integrations > Identity Provider](https://app.netbird.io/integrations?tab=identity-provider) and select `Connect Okta`. | ||
* On the top right, click on your username | ||
* Copy your [Okta account domain](https://developer.okta.com/docs/guides/find-your-domain/main/) as shown below: | ||
|
||
<p> | ||
<img src="/docs-static/img/how-to-guides/netbird-idp-list.png" alt="NetBird Identity Provider List" className="imagewrapper-big"/> | ||
</p> | ||
![Okta Copy Domain](/docs-static/img/how-to-guides/okta-sync/eITyobI.png) | ||
|
||
- Follow the displayed instructions to link your Okta account. Ensure to note the `Authorization(Bearer) token` generated for use in the subsequent step. | ||
The final step is to [send an email to the NetBird team]([email protected]) with the authentication information you just retrieved: | ||
|
||
<p> | ||
<img src="/docs-static/img/how-to-guides/okta-scim-credentials.png" alt="Okta SCIM Credentials" className="imagewrapper-big"/> | ||
</p> | ||
* Okta `Client ID` | ||
* Okta `Client secret` | ||
* Okta account domain | ||
* Okta primary email domain (usually your username) | ||
|
||
##### Step 3: Enable Provisioning in Okta | ||
You will receive an email once the NetBird team enables authentication for your account. | ||
|
||
- From the Okta dashboard, navigate to `Applications > Applications` and select the `NetBird` application. | ||
- Under the` Provisioning` tab, choose `Integration`, then select `Configure API Integration` | ||
<p> | ||
<img src="/docs-static/img/how-to-guides/okta-provisioning.png" alt="Okta Provisioning Configuration" className="imagewrapper-big"/> | ||
</p> | ||
This completes the first stage, enabling Single Sign-On (SSO) from NetBird's login page using Okta credentials. Now, you can navigate to [app.netbird.io](app.netbird.io) and log in using [Okta Verify](https://help.okta.com/eu/en-us/content/topics/end-user/ov-overview.htm). | ||
|
||
- Opt to `Enable API integration` and insert previously noted `Authorization(Bearer) token` into the `API Token` field. | ||
## Enabling Okta SCIM in NetBird | ||
|
||
<p> | ||
<img src="/docs-static/img/how-to-guides/okta-provisioning-enabled.png" alt="Enabling Okta Provisioning" className="imagewrapper-big"/> | ||
</p> | ||
In NetBird, go to `Integrations > Identity Provider` and click on the `Connect to Okta` button. | ||
|
||
- Click `Test API Credentials` to verify the SCIM connection, then select `Save`. | ||
- Navigate to `Provisioning > Settings > To App`, click `Edit`, enable `Create Users`, `Update User Attributes`, and `Deactivate Users`, then select `Save`. | ||
![NetBird Connect to Okta](/docs-static/img/how-to-guides/okta-sync/QbzudIU.png) | ||
|
||
<p> | ||
<img src="/docs-static/img/how-to-guides/okta-to-app-configuration.png" alt="Okta to App Configuration" className="imagewrapper-big"/> | ||
</p> | ||
You will see a reminder of the permissions your user will require in Okta. Click the `Get Started →` button to continue. | ||
|
||
##### Step 4: Sync Users to NetBird | ||
- Access the `Assignments` tab, click `Assign`, then `Assign to Groups`. | ||
- Choose the groups for provisioning, select `Assign` and then `Save and Go Back`. | ||
- Click `Done` to conclude the group assignment process. | ||
![NetBird User Permissions](/docs-static/img/how-to-guides/okta-sync/RBsJlzu.png) | ||
|
||
<p> | ||
<img src="/docs-static/img/how-to-guides/okta-assign-users-by-group.png" alt="high-level-dia" className="imagewrapper-big"/> | ||
</p> | ||
If you haven't already, you'll need to set up SSO in Okta. If you've completed the previous section, skip this step and click the `Continue →` button. | ||
|
||
#### Step 5. Sync groups to NetBird | ||
- Access the `Push Groups` tab | ||
<p> | ||
<img src="/docs-static/img/how-to-guides/okta-push-groups.png" alt="high-level-dia" className="imagewrapper-big"/> | ||
</p> | ||
![NetBird SSO in Okta](/docs-static/img/how-to-guides/okta-sync/XYpJYW3.png) | ||
|
||
- Select the `Push Groups` and then `Find groups by name` | ||
- Search groups to push and then click `Save` | ||
- The selected groups will then be synced to NetBird. | ||
The next screen will show you how to enable NetBird API credentials in Okta. Copy the value of the `Authorization (Bearer)` token. | ||
|
||
![NetBird Enable Okta SCIM](/docs-static/img/how-to-guides/okta-sync/aoPqKJR.png) | ||
|
||
Navigate to the NetBird app in your Okta admin dashboard. Click the `Provisioning` tab, then select `Configure API Integration`. | ||
|
||
![Okta Provisioning](/docs-static/img/how-to-guides/okta-sync/m27djab.png) | ||
|
||
Follow these steps: | ||
|
||
* Check the box to enable API Integration. | ||
* Enter your NetBird API Token. | ||
* Click `Test API Credentials` to verify the SCIM connection. | ||
|
||
![Okta Entering NetBird Bearer Token](/docs-static/img/how-to-guides/okta-sync/Wn6f9Pj.png) | ||
|
||
If everything works as expected, you'll see the message: "NetBird was verified successfully!" as shown below. Click `Save` to continue. | ||
|
||
![Okta Token Accepted](/docs-static/img/how-to-guides/okta-sync/7ELQBIA.png) | ||
|
||
## Configuring SCIM Provisioning to NetBird | ||
|
||
On NetBird, click `Continue →`. You'll see instructions for configuring SCIM provisioning to NetBird. | ||
|
||
![NetBird Configure SCIM provisioning to NetBird](https://imgur.com/wBX2k3r.png) | ||
|
||
Back to Okta, click `Edit` as shown below. | ||
|
||
![Okta Edit NetBird App](/docs-static/img/how-to-guides/okta-sync/AcuWP2G.png) | ||
|
||
Enable Okta to create, update, and deactivate NetBird users by checking the corresponding boxes: | ||
|
||
* Create Users | ||
* Update User Attibutes | ||
* Deactivate Users | ||
|
||
When done, click `Save`. | ||
|
||
![Okta Enable Create Users and More](/docs-static/img/how-to-guides/okta-sync/JD0EHVI.png) | ||
|
||
## Assigning NetBird Application to Okta Groups | ||
|
||
In NetBird, click `Continue →`, you'll see the steps for assigning the NetBird integration to Okta groups. | ||
|
||
![NetBird Sync Groups to NetBird](/docs-static/img/how-to-guides/okta-sync/fLHSNsd.png) | ||
|
||
* Navigate to the `Assignments` tab. | ||
* Similar than before when you assigned your user to NetBird app, click the `Assign` button | ||
* This time, select `Assign to Groups`. | ||
* Select Okta groups that you want to assign to the NetBird app. | ||
|
||
![Okta Assign NetBird to Groups](/docs-static/img/how-to-guides/okta-sync/yGV0u5Y.png) | ||
|
||
Once you assign the desired groups, click `Done`. You'll see the selected groups listed in Okta. | ||
|
||
![Okta NetBird Groups](/docs-static/img/how-to-guides/okta-sync/mxkdWc0.png) | ||
|
||
## Push Okta Groups to NetBird | ||
|
||
One more time, go to NetBird and click `Continue →`. You'll see the final instructions to push Okta groups to NetBird. | ||
|
||
![NetBird Sync Groups to NetBird](/docs-static/img/how-to-guides/okta-sync/8TAvguS.png) | ||
|
||
* In Okta, navigate to `Push Groups` tab | ||
* Click the `Push Groups` buttom | ||
* Select `Find groups by name` | ||
* Search for specific groups to push to NetBird. | ||
|
||
![XX](/docs-static/img/how-to-guides/okta-sync/uqUiTtg.png) | ||
|
||
Once you finish, go back to NetBird and click `Finish Setup`. You can verify the syncronization by navigating to `Team > Users` | ||
|
||
![XX](/docs-static/img/how-to-guides/okta-sync/GPTzvut.png) | ||
|
||
The users listed in NetBird should match those you created in Okta. | ||
|
||
![XX](/docs-static/img/how-to-guides/okta-sync/O1aoILr.png) | ||
|
||
<Note> | ||
SCIM provisioning will manage only resources that are created through Okta. Any resources created directly in | ||
NetBird will not be managed by SCIM. | ||
SCIM provisioning will manage only resources that are created through Okta. Any resources created directly in NetBird will not be managed by SCIM. | ||
</Note> | ||
|
||
<Note> | ||
Synced groups will only be available for membership and will not change the role of user in NetBird. | ||
Synced groups will only be available for membership and will not change the role of user in NetBird | ||
</Note> |