diff --git a/misc/idp-sync/api.md b/misc/idp-sync/api.md index 5cebd802..94e4e9b4 100644 --- a/misc/idp-sync/api.md +++ b/misc/idp-sync/api.md @@ -6,19 +6,19 @@ This reference provides detailed information on managing integrations via NetBir ## Authentication Authentication is required for all API requests. Please refer to the [authentication guideline](https://docs.netbird.io/how-to/access-netbird-public-api) for how to create and authenticate API calls using Personal Access Tokens (PAT). -## Google Workspace Integration +## Google Endpoints ### Create Integration -The new integration synchronization is enabled by default when created. +By default, for new integration synchronization is enabled. Request: -- `serviceAccountKey`: 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). -Encode service account JSON to base64 by using the command: +- `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). + Encode service account JSON to base64 by using the command: ```shell base64 -i ``` -- `syncInterval`: Optional. The default value is 300 seconds. +- `sync_interval`: Optional. The default value is 300 seconds. ```shell curl --request POST \ @@ -27,7 +27,7 @@ curl --request POST \ --header 'Authorization: Token ' \ --header 'Content-Type: application/json' \ --data '{ - "serviceAccountKey": "", + "service_account_key": "", "customerID": "" }' ``` @@ -36,8 +36,8 @@ Response ```json { "id": , - "customerId": ", - "customerId": ", - "customerId": "", - "syncInterval": 300, + "customer_id": "", + "sync_interval": 300, "enabled": true } ] @@ -102,13 +102,13 @@ Response Updates the selected parameters for a specific integration. Request -- `serviceAccountKey`: 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](idp.md). Encode service account JSON to base64 by using the command: ```shell base64 -i ``` -- `syncInterval`: Optional. Should not be less than 300 seconds. -- `enabled`: Optional. Used to disable/enable the integration. +- `sync_interval`: Optional. Should not be less than 300 seconds. +- `enabled`: Optional. Used to disable/enable the integration. ```shell curl --request PUT \ @@ -117,8 +117,8 @@ curl --request PUT \ --header 'Authorization: Token ' \ --header 'Content-Type: application/json' \ --data '{ - "serviceAccountKey": "", - "syncInterval": 300, + "service_account_key": "", + "sync_interval": 300, "enabled": false }' ``` @@ -127,8 +127,8 @@ Response ```json { "id": , - "customerId": "", - "syncInterval": 300, + "customer_id": "", + "sync_interval": 300, "enabled": false } ``` @@ -167,21 +167,21 @@ Response ``` -## Azure AD Integration +## 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). ### Create Integration -The new integration synchronization is enabled by default when created. +By default, for new integration synchronization is enabled. Request: -- `clientSecret`: A Base64 encoded string derived from Azure Directory application client credential secret. +- `client_secret`: A Base64 encoded string derived from Azure Directory application client credential secret. Encode service account JSON to base64 by using the command: ```shell echo -n | base64 ``` -- `clientId`: Azure Directory application client Id. -- `tenantId`: Azure Directory ID. -- `syncInterval`: Optional. The default value is 300 seconds. +- `client_id`: Azure Directory application client Id. +- `tenant_id`: Azure Directory ID. +- `sync_interval`: Optional. The default value is 300 seconds. ```shell curl --request POST \ @@ -190,9 +190,9 @@ curl --request POST \ --header 'Authorization: Token ' \ --header 'Content-Type: application/json' \ --data '{ - "clientSecret": "", - "clientId": "", - "tenantId": "" + "client_secret": "", + "client_id": "", + "tenant_id": "" }' ``` @@ -200,9 +200,9 @@ Response ```json { "id": , - "clientId": "", - "tenantId": "", - "syncInterval": 300, + "client_id": "", + "tenant_id": "", + "sync_interval": 300, "enabled": true } ``` @@ -220,9 +220,9 @@ Response ```json { "id": , - "clientId": "", - "tenantId": "", - "syncInterval": 300, + "client_id": "", + "tenant_id": "", + "sync_interval": 300, "enabled": true } ``` @@ -241,9 +241,9 @@ Response [ { "id": , - "clientId": "", - "tenantId": "", - "syncInterval": 300, + "client_id": "", + "tenant_id": "", + "sync_interval": 300, "enabled": true } ] @@ -269,12 +269,12 @@ Response Updates the selected parameters for a specific integration. Request -- `clientSecret`: A Base64 encoded string derived from Azure Directory application client credential secret. +- `client_secret`: A Base64 encoded string derived from Azure Directory application client credential secret. Encode service account JSON to base64 by using the command: ```shell echo -n | base64 ``` -- `syncInterval`: Optional. Should not be less than 300 seconds. +- `sync_interval`: Optional. Should not be less than 300 seconds. - `enabled`: Optional. Used to disable/enable the integration. ```shell @@ -284,8 +284,8 @@ curl --request PUT \ --header 'Authorization: Token ' \ --header 'Content-Type: application/json' \ --data '{ - "clientSecret": "", - "syncInterval": 300, + "client_secret": "", + "sync_interval": 300, "enabled": false }' ``` @@ -294,9 +294,9 @@ Response ```json { "id": , - "clientId": "", - "tenantId": "", - "syncInterval": 300, + "client_id": "", + "tenant_id": "", + "sync_interval": 300, "enabled": true } ``` diff --git a/misc/idp-sync/idp.md b/misc/idp-sync/idp.md index 52ca70b9..0b8e48ba 100644 --- a/misc/idp-sync/idp.md +++ b/misc/idp-sync/idp.md @@ -14,8 +14,8 @@ Before you start creating and configuring an Google Workspace application, ensur - Navigate to [API Credentials](https://console.cloud.google.com/apis/credentials) page - Click `CREATE CREDENTIALS` at the top and select `Service account` - Fill in the form with the following values and click `CREATE` - - Service account name: `NetBird` - - Service account ID: `netbird` + - Service account name: `NetBird` + - Service account ID: `netbird` - Click `DONE`

service-account-create @@ -41,8 +41,8 @@ Read how to manage and secure your service keys [here](https://cloud.google.com/ - Select `Account` on the left menu and then click `Admin Roles` - Click `Create new role` - Fill in the form with the following values and click `CREATE` - - name: `User and Group Management ReadOnly` - - description: `User and Group Management ReadOnly` + - name: `User and Group Management ReadOnly` + - description: `User and Group Management ReadOnly` - Click `CONTINUE`

new-admin-role @@ -74,7 +74,7 @@ Read how to manage and secure your service keys [here](https://cloud.google.com/ 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 -and manage Azure AD applications. If you don't have the required permissions, ask your Azure AD administrator to grant them to you. + and manage Azure AD applications. If you don't have the required permissions, ask your Azure AD administrator to grant them to you. #### Step 1. Create and configure Azure AD application - Navigate to [Azure Active Directory](https://portal.azure.com/#view/Microsoft_AAD_IAM/ActiveDirectoryMenuBlade/~/Overview)