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

Adjust screenshots sizes (#174)

Browse Source
This commit is contained in:
juliaroesschen
2024-03-26 11:00:20 +01:00
committed by GitHub
parent a56a607923
commit 1a0f99fae7
31 changed files with 92 additions and 83 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -23,14 +23,14 @@ Before you start creating and configuring an Google Workspace application, ensur
- Service account ID: `netbird`
- Click `DONE`
<p>
<img src="/docs-static/img/how-to-guides/google-service-account-create.png" alt="service-account-create"/>
<img src="/docs-static/img/how-to-guides/google-service-account-create.png" alt="service-account-create" className="imagewrapper-big"/>
</p>
#### Step 2: Create service account keys
- Navigate to [API Credentials](https://console.cloud.google.com/apis/credentials) page
- Under `Service Accounts` click the `NetBird` to edit the service account
<p>
<img src="/docs-static/img/how-to-guides/google-edit-service-account.png" alt="edit-service-account"/>
<img src="/docs-static/img/how-to-guides/google-edit-service-account.png" alt="edit-service-account" className="imagewrapper-big"/>
</p>
- Take note of service account email address, we will use it in next steps
@@ -50,26 +50,26 @@ Read how to manage and secure your service keys [here](https://cloud.google.com/
- description: `User and Group Management ReadOnly`
- Click `CONTINUE`
<p>
<img src="/docs-static/img/how-to-guides/google-new-admin-role.png" alt="new-admin-role"/>
<img src="/docs-static/img/how-to-guides/google-new-admin-role.png" alt="new-admin-role" className="imagewrapper-big"/>
</p>
- Scroll down to `Admin API privileges` and add the following privileges
- Users: `Read`
- Groups: `Read`
<p>
<img src="/docs-static/img/how-to-guides/google-privileges-review.png" alt="privileges-review"/>
<img src="/docs-static/img/how-to-guides/google-privileges-review.png" alt="privileges-review" className="imagewrapper-big"/>
</p>
- Verify preview of assigned Admin API privileges to ensure that everything is properly configured, and then click `CREATE ROLE`
- Click `Assign service accounts`, add service account email address and then click `ADD`
<p>
<img src="/docs-static/img/how-to-guides/google-assign-service-account.png" alt="assign-service-account" />
<img src="/docs-static/img/how-to-guides/google-assign-service-account.png" alt="assign-service-account" className="imagewrapper-big"/>
</p>
- Click `ASSIGN ROLE` to assign service account to `User and Group Management ReadOnly` admin role
<p>
<img src="/docs-static/img/how-to-guides/google-service-account-privileges.png" alt="service-account-privileges" />
<img src="/docs-static/img/how-to-guides/google-service-account-privileges.png" alt="service-account-privileges" className="imagewrapper-big"/>
</p>
- Navigate to [Account Settings](https://admin.google.com/ac/accountsettings/profile?hl=en_US) page and take note of `Customer ID`
@@ -88,7 +88,7 @@ Before you start creating and configuring an Azure AD application, ensure that y
- Name: `NetBird`
<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" className="imagewrapper-big"/>
</p>
@@ -100,13 +100,13 @@ Before you start creating and configuring an Azure AD application, ensure that y
- In `Select permissions` select `User.Read.All` and `Group.Read.All` and click `Add permissions`
<p>
<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" className="imagewrapper-big"/>
</p>
- Click `Grant admin consent for Default Directory` and click `Yes`
<p>
<img src="/docs-static/img/how-to-guides/azure-grant-admin-consent.png" alt="azure-grant-admin-consent"/>
<img src="/docs-static/img/how-to-guides/azure-grant-admin-consent.png" alt="azure-grant-admin-consent" className="imagewrapper-big"/>
</p>
#### Step 3. Generate client secret
@@ -117,7 +117,7 @@ Before you start creating and configuring an Azure AD application, ensure that y
- Copy `Value` and save it as it can be viewed only once after creation.
<p>
<img src="/docs-static/img/how-to-guides/azure-client-secret.png" alt="azure-client-secret" />
<img src="/docs-static/img/how-to-guides/azure-client-secret.png" alt="azure-client-secret" className="imagewrapper-big"/>
</p>
- Navigate to [Owner applications](https://portal.azure.com/#view/Microsoft_AAD_IAM/ActiveDirectoryMenuBlade/~/RegisteredApps).
@@ -135,14 +135,14 @@ In this step, we will create and configure NetBird SAML 2.0 application in okta.
- Sign-in method: `SAML 2.0`
<p>
<img src="/docs-static/img/how-to-guides/okta-new-application.png" alt="high-level-dia" />
<img src="/docs-static/img/how-to-guides/okta-new-application.png" alt="high-level-dia" className="imagewrapper-big"/>
</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" />
<img src="/docs-static/img/how-to-guides/okta-saml-general-settings.png" alt="high-level-dia" className="imagewrapper-big"/>
</p>
- Fill in the form will the following values and click `Next`
@@ -150,12 +150,12 @@ In this step, we will create and configure NetBird SAML 2.0 application in okta.
- Audience URI (SP Entity ID): `http://localhost`
<p>
<img src="/docs-static/img/how-to-guides/okta-saml-configuration.png" alt="high-level-dia" />
<img src="/docs-static/img/how-to-guides/okta-saml-configuration.png" alt="high-level-dia" className="imagewrapper-big"/>
</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" />
<img src="/docs-static/img/how-to-guides/okta-saml-configuration-feedback.png" alt="high-level-dia" className="imagewrapper-big"/>
</p>
#### Step 2. Create Okta SCIM integration
@@ -169,14 +169,14 @@ Before proceeding with this step, we need to create
- 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" />
<img src="/docs-static/img/how-to-guides/okta-netbird-app-overview.png" alt="high-level-dia" className="imagewrapper-big"/>
</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" />
<img src="/docs-static/img/how-to-guides/okta-scim-provisioning-enabled.png" alt="high-level-dia" className="imagewrapper-big"/>
</p>
- Click `Provisioning` and under `SCIM connection` click `Edit`
@@ -188,28 +188,28 @@ Before proceeding with this step, we need to create
- 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" />
<img src="/docs-static/img/how-to-guides/okta-scim-provisioning-settings.png" alt="high-level-dia" className="imagewrapper-big"/>
</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" />
<img src="/docs-static/img/how-to-guides/okta-connector-configuration-test.png" alt="high-level-dia" className="imagewrapper-big"/>
</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" />
<img src="/docs-static/img/how-to-guides/okta-scim-to-app-configuration.png" alt="high-level-dia" className="imagewrapper-big"/>
</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" />
<img src="/docs-static/img/how-to-guides/okta-scim-to-app-sync-enabled.png" alt="high-level-dia" className="imagewrapper-big"/>
</p>
#### Step 4. Assign groups to application and push to NetBird
@@ -220,7 +220,7 @@ access without using the groups, you can learn how to do it [here](https://help.
- Go to the `Assignments` tab.
<p>
<img src="/docs-static/img/how-to-guides/okta-groups-assignments.png" alt="high-level-dia" />
<img src="/docs-static/img/how-to-guides/okta-groups-assignments.png" alt="high-level-dia" className="imagewrapper-big"/>
</p>
- Select the `Assign` and then click `Assign to Groups`
@@ -232,17 +232,17 @@ At this point, all members of the groups assigned to the application will be syn
- Go to the `Push Groups` tab
<p>
<img src="/docs-static/img/how-to-guides/okta-sync-groups.png" alt="high-level-dia" />
<img src="/docs-static/img/how-to-guides/okta-sync-groups.png" alt="high-level-dia" className="imagewrapper-big"/>
</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" />
<img src="/docs-static/img/how-to-guides/okta-push-group-assignment.png" alt="high-level-dia" className="imagewrapper-big"/>
</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" />
<img src="/docs-static/img/how-to-guides/okta-group-push-status.png" alt="high-level-dia" className="imagewrapper-big"/>
</p>