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

Create a SCIM IDP integration

Creates a new SCIM IDP integration. Supply prefix and provider to identify the SCIM connection and provider; connector and group-prefix settings can also be included. The response contains the created integration.

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

5 body fields

SCIM IDP integration configuration, including the required connection prefix and provider name.

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
prefixstringrequired
The connection prefix used for the SCIM provider
providerstringrequired
Name of the SCIM identity provider

4 status codes
200Returns the created SCIM IDP integration object, including its ID, enabled state, prefix, provider, group prefixes, user group prefixes, authentication token, and last synchronization 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
auth_tokenstringrequired
SCIM API token (full on creation, masked otherwise)
idintegerrequired
The unique identifier for the integration
last_synced_atstringrequired
Timestamp of when the integration was last synced
prefixstringrequired
The connection prefix used for the SCIM provider
providerstringrequired
Name of the SCIM identity provider
400Returned when the JSON body is invalid, a required field is missing, or validation fails.
messagestringoptional
A human-readable error message.
401Returned when the request has no valid authentication token.
messagestringoptional
A human-readable error message.
500Returned when an internal server error occurs.
messagestringoptional
A human-readable error message.

Error handling

prefix and provider are required. A 400 is returned when the JSON body is invalid, a required field is missing, or validation fails; a 401 is returned when authentication is missing or invalid. A 500 is returned for an internal server error.