diff --git a/misc/idp-sync/api.md b/misc/idp-sync/api.md index 827ff07f..a61b0644 100644 --- a/misc/idp-sync/api.md +++ b/misc/idp-sync/api.md @@ -17,9 +17,10 @@ Encode service account JSON to base64 by using the command: ```shell base64 -i ``` -- `sync_interval`: Optional. The default value is 300 seconds. -- `group_prefixes`: Specifies list of starts_with patterns for group provision. If the group name matches one the the pattern it will be provisioned regardless of the members. Optional. The default value is empty list. -- `user_group_prefixes`: Specifies list of starts_with patterns for user provision. If the user belongs to group which name matches one the the pattern the user will be provisioned. Optional. The default value is empty list. +- `customer_id`: Customer ID from the profile info that can be found in Google Admin -> Account -> Accounts settings. +- `sync_interval`: Optional. The default value is 300 seconds. +- `group_prefixes`: Optional. Specifies list of starts_with patterns for group provision. If the group name matches one the the pattern it will be provisioned regardless of the members. The default value is empty list. +- `user_group_prefixes`: Optional. Specifies list of starts_with patterns for user provision. If the user belongs to group which name matches one the the pattern the user will be provisioned. The default value is empty list. ```shell curl --request POST \ @@ -29,7 +30,7 @@ curl --request POST \ --header 'Content-Type: application/json' \ --data '{ "service_account_key": "", - "customerID": "", + "customer_id": "", "group_prefixes": [], "user_group_prefixes": [] }' @@ -111,14 +112,15 @@ 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](https://docs.netbird.io/how-to/idp-sync#google-work-space). +- `service_account_key`: Optional. 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 ``` -- `sync_interval`: Optional. Should not be less than 300 seconds. -- `group_prefixes`: Specifies list of starts_with patterns for group provision. If the group name matches one the the pattern it will be provisioned regardless of the members. Optional. The default value is empty list. -- `user_group_prefixes`: Specifies list of starts_with patterns for user provision. If the user belongs to group which name matches one the the pattern the user will be provisioned. Optional. The default value is empty list. +- `customer_id`: Optional. Customer ID from the profile info that can be found in Google Admin -> Account -> Accounts settings. +- `sync_interval`: Optional. Should not be less than 300 seconds. +- `group_prefixes`: Optional. Specifies list of starts_with patterns for group provision. If the group name matches one the the pattern it will be provisioned regardless of the members. The default value is empty list. +- `user_group_prefixes`: Optional. Specifies list of starts_with patterns for user provision. If the user belongs to group which name matches one the the pattern the user will be provisioned. The default value is empty list. - `enabled`: Optional. Used to disable/enable the integration. ```shell @@ -197,8 +199,8 @@ Request: - `client_id`: Azure Directory application client Id. - `tenant_id`: Azure Directory ID. - `sync_interval`: Optional. The default value is 300 seconds. -- `group_prefixes`: Specifies list of starts_with patterns for group provision. If the group name matches one the the pattern it will be provisioned regardless of the members. Optional. The default value is empty list. -- `user_group_prefixes`: Specifies list of starts_with patterns for user provision. If the user belongs to group which name matches one the the pattern the user will be provisioned. Optional. The default value is empty list. +- `group_prefixes`: Optional. Specifies list of starts_with patterns for group provision. If the group name matches one the the pattern it will be provisioned regardless of the members. The default value is empty list. +- `user_group_prefixes`: Optional. Specifies list of starts_with patterns for user provision. If the user belongs to group which name matches one the the pattern the user will be provisioned. The default value is empty list. - `enabled`: Optional. Used to disable/enable the integration. ```shell @@ -293,14 +295,16 @@ Response Updates the selected parameters for a specific integration. Request -- `client_secret`: A Base64 encoded string derived from Azure Directory application client credential secret. +- `client_secret`: Optional. 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 ``` -- `sync_interval`: Optional. Should not be less than 300 seconds. -- `group_prefixes`: Specifies list of starts_with patterns for group provision. If the group name matches one the the pattern it will be provisioned regardless of the members. Optional. The default value is empty list. -- `user_group_prefixes`: Specifies list of starts_with patterns for user provision. If the user belongs to group which name matches one the the pattern the user will be provisioned. Optional. The default value is empty list. +- `client_id`: Optional. Azure Directory application client Id. +- `tenant_id`: Optional. Azure Directory ID. +- `sync_interval`: Optional. Should not be less than 300 seconds. +- `group_prefixes`: Optional. Specifies list of starts_with patterns for group provision. If the group name matches one the the pattern it will be provisioned regardless of the members. The default value is empty list. +- `user_group_prefixes`: Optional. Specifies list of starts_with patterns for user provision. If the user belongs to group which name matches one the the pattern the user will be provisioned. The default value is empty list. - `enabled`: Optional. Used to disable/enable the integration. ```shell