NetBird Full API Reference + Read-Only MCP Prototype
POST/api/integrations/google-idp

Create a Google Workspace identity provider integration

Creates a Google Workspace identity provider integration. Supply service_account_key and customer_id; sync_interval must be at least 300 seconds when provided and defaults to 300 seconds. A 200 response returns the created integration and its configuration.

  • IdempotentThe SDK sends Idempotency-Key, so a retried request is only applied once.

6 body fields

Google Workspace credentials and optional configuration for the identity provider integration.

connector_idstringoptional
DEX connector ID for embedded IDP setups
group_prefixesarray<string>optional
List of start_with string patterns for groups to sync
user_group_prefixesarray<string>optional
List of start_with string patterns for groups which users to sync
customer_idstringrequired
Customer ID from Google Workspace Account Settings
service_account_keystringrequired
Base64-encoded Google service account key
sync_intervalintegeroptional
Sync interval in seconds (minimum 300). Defaults to 300 if not specified.

4 status codes
200Returns the created Google Workspace identity provider integration, including its identifier, customer ID, sync interval, enabled state, group prefixes, and last sync time.
enabledbooleanrequired
Whether the integration is enabled
connector_idstringoptional
DEX connector ID for embedded IDP setups
group_prefixesarray<string>required
List of start_with string patterns for groups to sync
user_group_prefixesarray<string>required
List of start_with string patterns for groups which users to sync
customer_idstringrequired
Customer ID from Google Workspace
idintegerrequired
The unique identifier for the integration
last_synced_atstringrequired
Timestamp of the last synchronization
sync_intervalintegerrequired
Sync interval in seconds
400Returned when the JSON is invalid, a required field is missing, or a value fails validation.
messagestringoptional
A human-readable error message.
401Returned when the authentication token is missing or invalid.
messagestringoptional
A human-readable error message.
500Returned when an internal server error occurs.
messagestringoptional
A human-readable error message.

Error handling

service_account_key and customer_id are required; omitting either or providing invalid JSON or values returns a 400. sync_interval must be at least 300 seconds. A 401 is returned when the authentication token is missing or invalid, and a 500 indicates an internal server error.