NetBird Full API Reference + Read-Only MCP Prototype
GET/api/integrations/scim-idp/{id}

Get an SCIM IDP integration

Retrieves an SCIM IDP integration by its ID. Use this operation to inspect the integration's configuration and synchronization details.

1 parameter
idintegerrequired
The unique identifier of the SCIM IDP integration, as an integer.

5 status codes
200Returns the 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 integration ID has an invalid format.
messagestringoptional
A human-readable error message.
401Returned when the request is unauthorized.
messagestringoptional
A human-readable error message.
404Returned when no integration exists with the given ID.
messagestringoptional
A human-readable error message.
500Returned when an internal server error occurs.
messagestringoptional
A human-readable error message.

Error handling

A 400 is returned when id has an invalid format. A 401 is returned when the request is unauthorized, and a 404 is returned when no integration exists with the given ID. A 500 is returned for an internal server error.