Move IDP guidelines for user and group synchronization to the 'How To' documentation (#127)
@@ -12,7 +12,7 @@ Authentication is required for all API requests. Please refer to the [authentica
|
|||||||
By default, for new integration synchronization is enabled.
|
By default, for new integration synchronization is enabled.
|
||||||
|
|
||||||
Request:
|
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:
|
Encode service account JSON to base64 by using the command:
|
||||||
```shell
|
```shell
|
||||||
base64 -i <SERVICE_ACCOUNT_KEY_PATH>
|
base64 -i <SERVICE_ACCOUNT_KEY_PATH>
|
||||||
@@ -102,7 +102,7 @@ Response
|
|||||||
Updates the selected parameters for a specific integration.
|
Updates the selected parameters for a specific integration.
|
||||||
|
|
||||||
Request
|
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:
|
Encode service account JSON to base64 by using the command:
|
||||||
```shell
|
```shell
|
||||||
base64 -i <SERVICE_ACCOUNT_KEY_PATH>
|
base64 -i <SERVICE_ACCOUNT_KEY_PATH>
|
||||||
@@ -168,7 +168,7 @@ Response
|
|||||||
|
|
||||||
|
|
||||||
## Azure Endpoints
|
## 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
|
### Create Integration
|
||||||
By default, for new integration synchronization is enabled.
|
By default, for new integration synchronization is enabled.
|
||||||
|
|||||||
|
Before Width: | Height: | Size: 176 KiB After Width: | Height: | Size: 176 KiB |
|
Before Width: | Height: | Size: 196 KiB After Width: | Height: | Size: 196 KiB |
|
Before Width: | Height: | Size: 188 KiB After Width: | Height: | Size: 188 KiB |
|
Before Width: | Height: | Size: 132 KiB After Width: | Height: | Size: 132 KiB |
|
Before Width: | Height: | Size: 171 KiB After Width: | Height: | Size: 171 KiB |
|
Before Width: | Height: | Size: 118 KiB After Width: | Height: | Size: 118 KiB |
|
Before Width: | Height: | Size: 175 KiB After Width: | Height: | Size: 175 KiB |
|
Before Width: | Height: | Size: 182 KiB After Width: | Height: | Size: 182 KiB |
|
Before Width: | Height: | Size: 35 KiB After Width: | Height: | Size: 35 KiB |
|
Before Width: | Height: | Size: 82 KiB After Width: | Height: | Size: 82 KiB |
|
Before Width: | Height: | Size: 28 KiB After Width: | Height: | Size: 28 KiB |
|
Before Width: | Height: | Size: 32 KiB After Width: | Height: | Size: 32 KiB |
|
Before Width: | Height: | Size: 130 KiB After Width: | Height: | Size: 130 KiB |
|
Before Width: | Height: | Size: 117 KiB After Width: | Height: | Size: 117 KiB |
@@ -59,6 +59,7 @@ export const docsNavigation = [
|
|||||||
{ title: 'Examples', href: '/how-to/examples' },
|
{ title: 'Examples', href: '/how-to/examples' },
|
||||||
{ title: 'CLI', href: '/how-to/cli' },
|
{ title: 'CLI', href: '/how-to/cli' },
|
||||||
{ title: 'Delete your NetBird account', href: '/how-to/delete-account' },
|
{ title: 'Delete your NetBird account', href: '/how-to/delete-account' },
|
||||||
|
{ title: 'IdP sync', href: '/how-to/idp-sync' },
|
||||||
|
|
||||||
],
|
],
|
||||||
},
|
},
|
||||||
|
|||||||
@@ -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.
|
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:
|
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.
|
- 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`
|
- Service account ID: `netbird`
|
||||||
- Click `DONE`
|
- Click `DONE`
|
||||||
<p>
|
<p>
|
||||||
<img src="media/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"/>
|
||||||
</p>
|
</p>
|
||||||
|
|
||||||
#### Step 2: Create service account keys
|
#### Step 2: Create service account keys
|
||||||
- Navigate to [API Credentials](https://console.cloud.google.com/apis/credentials) page
|
- Navigate to [API Credentials](https://console.cloud.google.com/apis/credentials) page
|
||||||
- Under `Service Accounts` click the `NetBird` to edit the service account
|
- Under `Service Accounts` click the `NetBird` to edit the service account
|
||||||
<p>
|
<p>
|
||||||
<img src="media/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"/>
|
||||||
</p>
|
</p>
|
||||||
|
|
||||||
- Take note of service account email address, we will use it in next steps
|
- 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`
|
- description: `User and Group Management ReadOnly`
|
||||||
- Click `CONTINUE`
|
- Click `CONTINUE`
|
||||||
<p>
|
<p>
|
||||||
<img src="media/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"/>
|
||||||
</p>
|
</p>
|
||||||
|
|
||||||
- Scroll down to `Admin API privileges` and add the following privileges
|
- Scroll down to `Admin API privileges` and add the following privileges
|
||||||
- Users: `Read`
|
- Users: `Read`
|
||||||
- Groups: `Read`
|
- Groups: `Read`
|
||||||
<p>
|
<p>
|
||||||
<img src="media/google-privileges-review.png" alt="privileges-review"/>
|
<img src="/docs-static/img/how-to-guides/google-privileges-review.png" alt="privileges-review"/>
|
||||||
</p>
|
</p>
|
||||||
|
|
||||||
- Verify preview of assigned Admin API privileges to ensure that everything is properly configured, and then click `CREATE ROLE`
|
- 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`
|
- Click `Assign service accounts`, add service account email address and then click `ADD`
|
||||||
<p>
|
<p>
|
||||||
<img src="media/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" />
|
||||||
</p>
|
</p>
|
||||||
|
|
||||||
- Click `ASSIGN ROLE` to assign service account to `User and Group Management ReadOnly` admin role
|
- Click `ASSIGN ROLE` to assign service account to `User and Group Management ReadOnly` admin role
|
||||||
<p>
|
<p>
|
||||||
<img src="media/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" />
|
||||||
</p>
|
</p>
|
||||||
|
|
||||||
- Navigate to [Account Settings](https://admin.google.com/ac/accountsettings/profile?hl=en_US) page and take note of `Customer ID`
|
- 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:
|
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
|
- 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`
|
- Redirect URI: select `Single-page application (SPA)` and URI as `https://app.netbird.io/silent-auth`
|
||||||
|
|
||||||
<p>
|
<p>
|
||||||
<img src="media/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>
|
||||||
|
|
||||||
|
|
||||||
@@ -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`
|
- Under the `Single-page application` Section, add another URI `https://app.netbird.io/auth` and click `Save`
|
||||||
|
|
||||||
<p>
|
<p>
|
||||||
<img src="media/azure-spa-uri-setup.png" alt="azure-spa-uri-setup" />
|
<img src="/docs-static/img/how-to-guides/azure-spa-uri-setup.png" alt="azure-spa-uri-setup" />
|
||||||
</p>
|
</p>
|
||||||
|
|
||||||
|
|
||||||
@@ -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
|
- Click `Expose an API` on the left menu
|
||||||
- In `Application ID URI` click `Add` and then `Save`
|
- In `Application ID URI` click `Add` and then `Save`
|
||||||
<p>
|
<p>
|
||||||
<img src="media/azure-add-application-uri.png" alt="azure-add-application-uri" />
|
<img src="/docs-static/img/how-to-guides/azure-add-application-uri.png" alt="azure-add-application-uri" />
|
||||||
</p>
|
</p>
|
||||||
|
|
||||||
- Under `Scopes defined by this API` click `+ Add a Scope`
|
- 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`
|
- State: `Enabled`
|
||||||
|
|
||||||
<p>
|
<p>
|
||||||
<img src="media/azure-add-scope.png" alt="azure-add-scope" />
|
<img src="/docs-static/img/how-to-guides/azure-add-scope.png" alt="azure-add-scope" />
|
||||||
</p>
|
</p>
|
||||||
|
|
||||||
- Under `Authorized client Applications`, click on `+ add a client application` and enter the following:
|
- 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://`
|
- Client ID: same as your Application ID URI minus the `api://`
|
||||||
|
|
||||||
<p>
|
<p>
|
||||||
<img src="media/azure-authorize-application.png" alt="azure-authorize-application" />
|
<img src="/docs-static/img/how-to-guides/azure-authorize-application.png" alt="azure-authorize-application" />
|
||||||
</p>
|
</p>
|
||||||
|
|
||||||
#### Step 4. Add API permissions
|
#### 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`
|
- In `Select permissions` select `User.Read.All` and `Group.Read.All` and click `Add permissions`
|
||||||
|
|
||||||
<p>
|
<p>
|
||||||
<img src="media/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 conset for Default Directory` and click `Yes`
|
||||||
|
|
||||||
<p>
|
<p>
|
||||||
<img src="media/azure-grant-admin-conset.png" alt="azure-grant-admin-conset"/>
|
<img src="/docs-static/img/how-to-guides/azure-grant-admin-conset.png" alt="azure-grant-admin-conset"/>
|
||||||
</p>
|
</p>
|
||||||
|
|
||||||
#### Step 5. Update token version
|
#### 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.
|
- Copy `Value` and save it as it can be viewed only once after creation.
|
||||||
|
|
||||||
<p>
|
<p>
|
||||||
<img src="media/azure-client-secret.png" alt="azure-client-secret" />
|
<img src="/docs-static/img/how-to-guides/azure-client-secret.png" alt="azure-client-secret" />
|
||||||
</p>
|
</p>
|
||||||
|
|
||||||
- Navigate to [Owner applications](https://portal.azure.com/#view/Microsoft_AAD_IAM/ActiveDirectoryMenuBlade/~/RegisteredApps).
|
- Navigate to [Owner applications](https://portal.azure.com/#view/Microsoft_AAD_IAM/ActiveDirectoryMenuBlade/~/RegisteredApps).
|
||||||