Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

NetBird IDP SCIM Integrations API

Manage generic SCIM identity provider integrations for user and group sync.

NetBird IDP SCIM Integrations API is one of 39 APIs that NetBird publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include IDP SCIM Integrations. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 7 operations across 4 paths, and defines 8 schemas. It is described by OpenAPI 3.1.0, at version 0.0.1.

Requests are made against a single base URL, https://api.netbird.io.

7 operations 4 paths 8 schemas 1 DELETE3 GET2 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
0.0.1
Base URL
https://api.netbird.io
Authentication
HTTP Bearer, API Key
Resource Areas
1

Authentication & Security 2

NetBird IDP SCIM Integrations API declares 2 security schemes for authenticating requests. It accepts HTTP bearer tokens (JWT) (BearerAuth). An API key is passed in the header as Authorization (TokenAuth). By default, every request must be authenticated.

  • TokenAuth — Enter the token with the Token prefix, e.g. "Token nbpF3f0d.....".

Paths & Operations 7

Across 4 paths, the API surfaces 7 operations — 1 DELETE, 3 GET, 2 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

IDP SCIM Integrations 7

Manage generic SCIM identity provider integrations for user and group sync.

POST
/api/integrations/scim-idp
Create SCIM IDP Integration
createSCIMIntegration body → 200400401500
GET
/api/integrations/scim-idp
Get All SCIM IDP Integrations
getAllSCIMIntegrations → 200401500
GET
/api/integrations/scim-idp/{id}
Get SCIM IDP Integration
getSCIMIntegration 1 param → 200400401404500
PUT
/api/integrations/scim-idp/{id}
Update SCIM IDP Integration
updateSCIMIntegration 1 param body → 200400401404500
DELETE
/api/integrations/scim-idp/{id}
Delete SCIM IDP Integration
deleteSCIMIntegration 1 param → 200400401404500
POST
/api/integrations/scim-idp/{id}/token
Regenerate SCIM Token
regenerateSCIMToken 1 param → 200400401404500
GET
/api/integrations/scim-idp/{id}/logs
Get SCIM Integration Sync Logs
getSCIMIntegrationLogs 1 param → 200400401404500

Schemas 8

The contract defines 8 schemas that model the data the API accepts and returns. The most detailed are IdpIntegrationSyncLog (4 properties), IntegrationSyncFilters (3 properties), ScimTokenResponse (1 property), IntegrationEnabled (1 property). Each schema is shown below with its type and property counts.

UpdateScimIntegrationRequest
IntegrationEnabled
object
1 property
ScimTokenResponse
object
Response containing the regenerated SCIM token
1 property 1 required
ScimIntegration
IntegrationSyncFilters
object
3 properties
IdpIntegrationSyncLog
object
Represents a synchronization log entry for an integration
4 properties 4 required
CreateScimIntegrationRequest
ErrorResponse
object
Standard error response. Note: The exact structure of this error response is inferred from util.WriteErrorResponse and util.WriteError usage in the provided Go…
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

netbird-idp-scim-integrations-api-openapi.yml Raw ↑

Other APIs NetBird publishes across the network.

NetBird Accounts API
NetBird AWS Marketplace API
NetBird Checkout API
NetBird DNS API
NetBird DNS Zones API
NetBird EDR Falcon Integrations API
NetBird EDR FleetDM Integrations API
NetBird EDR Huntress Integrations API
NetBird EDR Intune Integrations API
NetBird EDR Peers API
NetBird EDR SentinelOne Integrations API
NetBird Event Streaming Integrations API