diff --git a/misc/idp-sync/api.md b/misc/idp-sync/api.md index b2e772fe..b81de47f 100644 --- a/misc/idp-sync/api.md +++ b/misc/idp-sync/api.md @@ -12,7 +12,7 @@ Authentication is required for all API requests. Please refer to the [authentica By default, for new integration synchronization is enabled. Request: -- `service_account_key`: A Base64 encoded string derived from a service account key JSON. For the creation of the service account key JSON, refer to the provided [IdP guideline](idp.md). +- `service_account_key`: A Base64 encoded string derived from a service account key JSON. For the creation of the service account key JSON, refer to the provided [IdP guideline](https://docs.netbird.io/how-to/idp-sync#google-work-space). Encode service account JSON to base64 by using the command: ```shell base64 -i @@ -102,7 +102,7 @@ Response Updates the selected parameters for a specific integration. Request -- `service_account_key`: A Base64 encoded string derived from a service account key JSON.For the creation of the service account key JSON, refer to the provided [IdP guideline](idp.md). +- `service_account_key`: A Base64 encoded string derived from a service account key JSON.For the creation of the service account key JSON, refer to the provided [IdP guideline](https://docs.netbird.io/how-to/idp-sync#google-work-space). Encode service account JSON to base64 by using the command: ```shell base64 -i @@ -168,7 +168,7 @@ Response ## Azure Endpoints -Before proceeding with the setup, please ensure that you have configured Azure as per the guidelines outlined in the [IdP guideline](idp.md). +Before proceeding with the setup, please ensure that you have configured Azure as per the guidelines outlined in the [IdP guideline](https://docs.netbird.io/how-to/idp-sync#azure-ad). ### Create Integration By default, for new integration synchronization is enabled. diff --git a/misc/idp-sync/media/azure-add-application-uri.png b/public/docs-static/img/how-to-guides/azure-add-application-uri.png similarity index 100% rename from misc/idp-sync/media/azure-add-application-uri.png rename to public/docs-static/img/how-to-guides/azure-add-application-uri.png diff --git a/misc/idp-sync/media/azure-add-scope.png b/public/docs-static/img/how-to-guides/azure-add-scope.png similarity index 100% rename from misc/idp-sync/media/azure-add-scope.png rename to public/docs-static/img/how-to-guides/azure-add-scope.png diff --git a/misc/idp-sync/media/azure-authorize-application.png b/public/docs-static/img/how-to-guides/azure-authorize-application.png similarity index 100% rename from misc/idp-sync/media/azure-authorize-application.png rename to public/docs-static/img/how-to-guides/azure-authorize-application.png diff --git a/misc/idp-sync/media/azure-client-secret.png b/public/docs-static/img/how-to-guides/azure-client-secret.png similarity index 100% rename from misc/idp-sync/media/azure-client-secret.png rename to public/docs-static/img/how-to-guides/azure-client-secret.png diff --git a/misc/idp-sync/media/azure-grant-admin-conset.png b/public/docs-static/img/how-to-guides/azure-grant-admin-conset.png similarity index 100% rename from misc/idp-sync/media/azure-grant-admin-conset.png rename to public/docs-static/img/how-to-guides/azure-grant-admin-conset.png diff --git a/misc/idp-sync/media/azure-new-application.png b/public/docs-static/img/how-to-guides/azure-new-application.png similarity index 100% rename from misc/idp-sync/media/azure-new-application.png rename to public/docs-static/img/how-to-guides/azure-new-application.png diff --git a/misc/idp-sync/media/azure-openid-permissions.png b/public/docs-static/img/how-to-guides/azure-openid-permissions.png similarity index 100% rename from misc/idp-sync/media/azure-openid-permissions.png rename to public/docs-static/img/how-to-guides/azure-openid-permissions.png diff --git a/misc/idp-sync/media/azure-spa-uri-setup.png b/public/docs-static/img/how-to-guides/azure-spa-uri-setup.png similarity index 100% rename from misc/idp-sync/media/azure-spa-uri-setup.png rename to public/docs-static/img/how-to-guides/azure-spa-uri-setup.png diff --git a/misc/idp-sync/media/google-assign-service-account.png b/public/docs-static/img/how-to-guides/google-assign-service-account.png similarity index 100% rename from misc/idp-sync/media/google-assign-service-account.png rename to public/docs-static/img/how-to-guides/google-assign-service-account.png diff --git a/misc/idp-sync/media/google-edit-service-account.png b/public/docs-static/img/how-to-guides/google-edit-service-account.png similarity index 100% rename from misc/idp-sync/media/google-edit-service-account.png rename to public/docs-static/img/how-to-guides/google-edit-service-account.png diff --git a/misc/idp-sync/media/google-new-admin-role.png b/public/docs-static/img/how-to-guides/google-new-admin-role.png similarity index 100% rename from misc/idp-sync/media/google-new-admin-role.png rename to public/docs-static/img/how-to-guides/google-new-admin-role.png diff --git a/misc/idp-sync/media/google-privileges-review.png b/public/docs-static/img/how-to-guides/google-privileges-review.png similarity index 100% rename from misc/idp-sync/media/google-privileges-review.png rename to public/docs-static/img/how-to-guides/google-privileges-review.png diff --git a/misc/idp-sync/media/google-service-account-create.png b/public/docs-static/img/how-to-guides/google-service-account-create.png similarity index 100% rename from misc/idp-sync/media/google-service-account-create.png rename to public/docs-static/img/how-to-guides/google-service-account-create.png diff --git a/misc/idp-sync/media/google-service-account-privileges.png b/public/docs-static/img/how-to-guides/google-service-account-privileges.png similarity index 100% rename from misc/idp-sync/media/google-service-account-privileges.png rename to public/docs-static/img/how-to-guides/google-service-account-privileges.png diff --git a/src/components/NavigationDocs.jsx b/src/components/NavigationDocs.jsx index 6005db85..ec8a0891 100644 --- a/src/components/NavigationDocs.jsx +++ b/src/components/NavigationDocs.jsx @@ -59,6 +59,7 @@ export const docsNavigation = [ { title: 'Examples', href: '/how-to/examples' }, { title: 'CLI', href: '/how-to/cli' }, { title: 'Delete your NetBird account', href: '/how-to/delete-account' }, + { title: 'IdP sync', href: '/how-to/idp-sync' }, ], }, diff --git a/misc/idp-sync/idp.md b/src/pages/how-to/idp-sync.mdx similarity index 79% rename from misc/idp-sync/idp.md rename to src/pages/how-to/idp-sync.mdx index 0b8e48ba..f4e3ca7a 100644 --- a/misc/idp-sync/idp.md +++ b/src/pages/how-to/idp-sync.mdx @@ -1,9 +1,9 @@ -# Introduction +## 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. -## Google WorkSpace +### Google WorkSpace Before you start creating and configuring an Google Workspace application, ensure that you have the following: - User account with admin permissions: You must have an Google Workspace user account with the admin permissions to create and manage Google Workspace applications. If you don't have the required permissions, ask your workspace administrator to grant them to you. @@ -18,14 +18,14 @@ Before you start creating and configuring an Google Workspace application, ensur - Service account ID: `netbird` - Click `DONE`

- service-account-create + service-account-create

#### 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

- edit-service-account + edit-service-account

- Take note of service account email address, we will use it in next steps @@ -45,32 +45,32 @@ Read how to manage and secure your service keys [here](https://cloud.google.com/ - description: `User and Group Management ReadOnly` - Click `CONTINUE`

- new-admin-role + new-admin-role

- Scroll down to `Admin API privileges` and add the following privileges - Users: `Read` - Groups: `Read`

- privileges-review + privileges-review

- 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`

- assign-service-account + assign-service-account

- Click `ASSIGN ROLE` to assign service account to `User and Group Management ReadOnly` admin role

- service-account-privileges + service-account-privileges

- Navigate to [Account Settings](https://admin.google.com/ac/accountsettings/profile?hl=en_US) page and take note of `Customer ID` -## Azure AD +### Azure AD Before you start creating and configuring an Azure AD application, ensure that you have the following: - User account with admin permissions: You must have an Azure AD user account with the appropriate permissions to create @@ -85,7 +85,7 @@ Before you start creating and configuring an Azure AD application, ensure that y - Redirect URI: select `Single-page application (SPA)` and URI as `https://app.netbird.io/silent-auth`

- azure-new-application + azure-new-application

@@ -94,7 +94,7 @@ Before you start creating and configuring an Azure AD application, ensure that y - Under the `Single-page application` Section, add another URI `https://app.netbird.io/auth` and click `Save`

- azure-spa-uri-setup + azure-spa-uri-setup

@@ -102,7 +102,7 @@ Before you start creating and configuring an Azure AD application, ensure that y - Click `Expose an API` on the left menu - In `Application ID URI` click `Add` and then `Save`

- azure-add-application-uri + azure-add-application-uri

- Under `Scopes defined by this API` click `+ Add a Scope` @@ -111,7 +111,7 @@ Before you start creating and configuring an Azure AD application, ensure that y - State: `Enabled`

- azure-add-scope + azure-add-scope

- Under `Authorized client Applications`, click on `+ add a client application` and enter the following: @@ -119,7 +119,7 @@ Before you start creating and configuring an Azure AD application, ensure that y - Client ID: same as your Application ID URI minus the `api://`

- azure-authorize-application + azure-authorize-application

#### Step 4. Add API permissions @@ -130,13 +130,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`

- azure-openid-permissions + azure-openid-permissions

- Click `Grant admin conset for Default Directory` and click `Yes`

- azure-grant-admin-conset + azure-grant-admin-conset

#### Step 5. Update token version @@ -152,7 +152,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.

- azure-client-secret + azure-client-secret

- Navigate to [Owner applications](https://portal.azure.com/#view/Microsoft_AAD_IAM/ActiveDirectoryMenuBlade/~/RegisteredApps).